libtelnet: Bindings to libtelnet

[ gpl, library, network ] [ Propose Tags ]

Binds https://github.com/seanmiddleditch/libtelnet , a C library for writing telnet clients and servers. See README.md or Network.Telnet.LibTelnet to get started.


[Skip to Readme]
Versions [faq] 0.1.0.0
Change log ChangeLog.md
Dependencies base (>=4.7 && <5), bytestring (>=0.10.6.0 && <0.11) [details]
License GPL-3.0-or-later
Copyright (c) 2017-2019 Jack Kelly
Author Jack Kelly
Maintainer jack@jackkelly.name
Category Network
Home page https://git.sr.ht/~jack/libtelnet-haskell
Bug tracker https://todo.sr.ht/~jack/libtelnet-haskell
Source repo head: git clone https://git.sr.ht/~jack/libtelnet-haskell
Uploaded by jack at Sun Feb 3 07:33:51 UTC 2019
Distributions NixOS:0.1.0.0
Executables example
Downloads 38 total (14 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs uploaded by user [build log]
All reported builds failed as of 2019-02-03 [all 1 reports]

Modules

[Index] [Quick Jump]

Flags

NameDescriptionDefaultType
example

Build the example program

DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for libtelnet-0.1.0.0

[back to package description]

Bindings to libtelnet

This is a wrapper around libtelnet, a C library for handling Telnet streams, including option negotiation, &c. As a cleartext protocol, Telnet is thorougly unsuitable for use on the open internet, but you might have a niche where it makes sense:

  • MU* games still use it, and so the clients people want to use only speak Telnet,
  • You might be speaking Telnet inside a stunnel, or
  • You might have some ancient hardware that can't be updated, and doesn't have ssh, but you want to talk to it using Haskell.

This library hews closely to the interface provided by the C libtelnet, so reading the excellent C documentation will help you. The short version goes something like this:

  1. Define an event handler of type Network.Telnet.LibTelnet.EventHandler. This function receives callbacks that tell you what received data should be propagated to the application, and what bytes need to be sent out over the socket.

  2. Pass your event handler (and some other flags) to Network.Telnet.LibTelnet.telnetInit, which will give you access to a Telnet, a garbage-collected state tracker.

  3. Tell the state tracker that data has arrived on the socket, or that you want to send data to the socket, by passing it to the library's other functions.

Other Resources