ref: 3b76fdedf4f32064e901989bbba737910b3e470b libtelnet-haskell/README.md -rw-r--r-- 1.9 KiB
3b76fdedJack Kelly Add CI failure email 2 years ago

#Bindings to libtelnet

builds.sr.ht status

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