Documentation
¶
Index ¶
Constants ¶
const ( SE = byte(240) NOP = byte(241) BRK = byte(243) IP = byte(244) AO = byte(245) AYT = byte(246) EC = byte(247) EL = byte(248) GA = byte(249) SB = byte(250) WILL = byte(251) WONT = byte(252) DO = byte(253) DONT = byte(254) IAC = byte(255) )
Telnet IAC constants
const ( ECHO = byte(1) TTYPE = byte(24) NAWS = byte(31) ENCRYPT = byte(38) EOR = byte(239) )
const Escape = byte('\033')
Variables ¶
var ( // styles Reset = []byte("\033[0m") Bold = []byte("\033[1m") Underline = []byte("\033[4m") Conceal = []byte("\033[8m") NormalWeight = []byte("\033[22m") NoUnderline = []byte("\033[24m") Reveal = []byte("\033[28m") // colors - foreground FGBlack = []byte("\033[30m") FGRed = []byte("\033[31m") FGGreen = []byte("\033[32m") FGYellow = []byte("\033[33m") FGBlue = []byte("\033[34m") FGMagenta = []byte("\033[35m") FGCyan = []byte("\033[36m") FGWhite = []byte("\033[37m") FGDefault = []byte("\033[39m") // background BGBlack = []byte("\033[40m") BGRed = []byte("\033[41m") BGGreen = []byte("\033[42m") BGYellow = []byte("\033[43m") BGBlue = []byte("\033[44m") BGMagenta = []byte("\033[45m") BGCyan = []byte("\033[46m") BGWhite = []byte("\033[47m") BGDefault = []byte("\033[49m") // xterm TitleBarFmt = "\033]0;%s\a" )
ANSI control sequences
Functions ¶
This section is empty.
Types ¶
type Connection ¶
type Connection struct {
// The underlying network connection.
net.Conn
// OptionHandlers handle IAC options; the key is the IAC option code.
OptionHandlers map[byte]Negotiator
// contains filtered or unexported fields
}
Connection to the telnet server. This lightweight TCPConn wrapper handles telnet control sequences transparently in reads and writes, and provides handling of supported options.
func NewConnection ¶
func NewConnection(c net.Conn, options []Option) *Connection
NewConnection initializes a new Connection for this given TCPConn. It will register all the given Option handlers and call Offer() on each, in order.
func (*Connection) RawWrite ¶
func (c *Connection) RawWrite(b []byte) (n int, err error)
RawWrite writes raw data to the connection, without escaping done by Write. Use of RawWrite over Conn.Write allows Connection to do any additional handling necessary, so long as it does not modify the raw data sent.
func (*Connection) Read ¶
func (c *Connection) Read(b []byte) (n int, err error)
Read from the connection, transparently removing and handling IAC control sequences. It may attempt multiple reads against the underlying connection if it receives back only IAC which gets stripped out of the stream.
func (*Connection) SetWindowTitle ¶
func (c *Connection) SetWindowTitle(title string)
SetWindowTitle attempts to set the client's telnet window title. Clients may or may not support this.
type HandleFunc ¶
type HandleFunc func(conn *Connection)
HandleFunc makes it easy to pass a function as a Handler instead of a full type.
func (HandleFunc) HandleTelnet ¶
func (f HandleFunc) HandleTelnet(conn *Connection)
HandleTelnet implements Handler, and simply calls the function.
type Handler ¶
type Handler interface {
HandleTelnet(conn *Connection)
}
Handler is a telnet connection handler. The Handler passed to a server will be called for all incoming connections.
type NAWSHandler ¶
NAWSHandler negotiates NAWS for a specific connection.
func (*NAWSHandler) HandleDo ¶
func (n *NAWSHandler) HandleDo(c *Connection)
func (*NAWSHandler) HandleSB ¶
func (n *NAWSHandler) HandleSB(_ *Connection, b []byte)
func (*NAWSHandler) HandleWill ¶
func (n *NAWSHandler) HandleWill(_ *Connection)
func (*NAWSHandler) Offer ¶
func (n *NAWSHandler) Offer(c *Connection)
func (*NAWSHandler) OptionCode ¶
func (n *NAWSHandler) OptionCode() byte
type Negotiator ¶
type Negotiator interface {
// OptionCode returns the 1-byte option code that indicates this option.
OptionCode() byte
// Offer is called when a new connection is initiated. It offers the handler
// an opportunity to advertise or request an option.
Offer(conn *Connection)
// HandleDo is called when an IAC DO command is received for this option,
// indicating the client is requesting the option to be enabled.
HandleDo(conn *Connection)
// HandleWill is called when an IAC WILL command is received for this
// option, indicating the client is willing to enable this option.
HandleWill(conn *Connection)
// HandleSB is called when a subnegotiation command is received for this
// option. body contains the bytes between `IAC SB <OptionCode>` and `IAC
// SE`.
HandleSB(conn *Connection, body []byte)
}
Negotiator defines the requirements for a telnet option handler.
func ExposeNAWS ¶
func ExposeNAWS(_ *Connection) Negotiator
ExposeNAWS enables NAWS negotiation on a Client.
func NAWSOption ¶
func NAWSOption(_ *Connection) Negotiator
NAWSOption enables NAWS negotiation on a Server.
type Option ¶
type Option func(c *Connection) Negotiator
Option functions add handling of a telnet option to a Server. The Option function takes a connection (which it can store but needn't) and returns a Negotiator; it is up to the Option function whether a single instance of the Negotiator is reused or if a new instance is created for each connection.
type Server ¶
type Server struct {
Address string
// contains filtered or unexported fields
}
Server listens for telnet connections.
func (*Server) ListenAndServe ¶
ListenAndServe runs the telnet server by creating a new Listener using the current Server.Address, and then calling Serve().
Source Files
Directories