telnet

package module
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 29, 2023 License: MIT Imports: 12 Imported by: 2

README

telnet

a telnet library for go

Documentation

Overview

Package telnet is a generated GoMock package.

Index

Constants

View Source 
const (
	// RFC 885
	EOR = 239 + iota // ef
	// RFC 854
	SE   // f0
	NOP  // f1
	DM   // f2
	BRK  // f3
	IP   // f4
	AO   // f5
	AYT  // f6
	EC   // f7
	EL   // f8
	GA   // f9
	SB   // fa
	WILL // fb
	WONT // fc
	DO   // fd
	DONT // fe
	IAC  // ff
)
View Source 
const (
	TransmitBinary  = 0  // RFC 856
	Echo            = 1  // RFC 857
	SuppressGoAhead = 3  // RFC 858
	Charset         = 42 // RFC 2066
	TerminalType    = 24 // RFC 930
	NAWS            = 31 // RFC 1073
	EndOfRecord     = 25 // RFC 885
)

Variables

View Source 
var ASCII encoding.Encoding = &asciiEncoding{}
View Source 
var Binary encoding.Encoding = &binaryEncoding{}

Functions

func NewOption 

func NewOption(c byte) *option

func NewReader 

func NewReader(r io.Reader, fn func(any) error) io.Reader

func NewWriter 

func NewWriter(w io.Writer) io.Writer

Types

type CharsetOption 

type CharsetOption struct {
	Option
	// contains filtered or unexported fields
}

func NewCharsetOption 

func NewCharsetOption(requireBinary bool) *CharsetOption

func (*CharsetOption) Bind added in v0.2.0 

func (c *CharsetOption) Bind(conn Conn, sink EventSink)

func (*CharsetOption) HandleEvent added in v0.2.0 

func (c *CharsetOption) HandleEvent(data any)

func (*CharsetOption) Subnegotiation 

func (c *CharsetOption) Subnegotiation(buf []byte)

type CharsetRequestedEvent added in v0.3.1 

type CharsetRequestedEvent struct {
	// contains filtered or unexported fields
}

type Conn 

type Conn interface {
	net.Conn
	Logger

	Role() ConnRole

	AddListener(string, EventListener)
	RemoveListener(string, EventListener)

	BindOption(o Option)
	EnableOptionForThem(option byte, enable bool) error
	EnableOptionForUs(option byte, enable bool) error
	Option(option byte) Option

	RequestEncoding(encoding.Encoding) error
	Send(p []byte) (n int, err error)
	SetEncoding(encoding.Encoding)
	SetLogger(Logger)
	SetReadEncoding(encoding.Encoding)
	SetWriteEncoding(encoding.Encoding)
	SuppressGoAhead(enabled bool)
}

func Client 

func Client(conn net.Conn) Conn

func Dial 

func Dial(addr string) (Conn, error)

func Server 

func Server(conn net.Conn) Conn

type ConnRole added in v0.3.1 

type ConnRole int
const (
	ClientRole ConnRole = iota
	ServerRole
)

type EventListener 

type EventListener interface {
	HandleEvent(any)
}

type EventSink 

type EventSink interface {
	SendEvent(event string, data any)
}

type FuncListener 

type FuncListener struct {
	Func func(any)
}

func (FuncListener) HandleEvent 

func (f FuncListener) HandleEvent(data any)

type Logger 

type Logger interface {
	Logf(fmt string, v ...any)
}

type MockConn 

type MockConn struct {
	// contains filtered or unexported fields
}

MockConn is a mock of Conn interface.

func NewMockConn 

func NewMockConn(ctrl *gomock.Controller) *MockConn

NewMockConn creates a new mock instance.

func (*MockConn) AddListener 

func (m *MockConn) AddListener(arg0 string, arg1 EventListener)

AddListener mocks base method.

func (*MockConn) BindOption 

func (m *MockConn) BindOption(arg0 Option)

BindOption mocks base method.

func (*MockConn) Close added in v0.3.0 

func (m *MockConn) Close() error

Close mocks base method.

func (*MockConn) EXPECT 

func (m *MockConn) EXPECT() *MockConnMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockConn) EnableOptionForThem 

func (m *MockConn) EnableOptionForThem(arg0 byte, arg1 bool) error

EnableOptionForThem mocks base method.

func (*MockConn) EnableOptionForUs 

func (m *MockConn) EnableOptionForUs(arg0 byte, arg1 bool) error

EnableOptionForUs mocks base method.

func (*MockConn) LocalAddr added in v0.3.0 

func (m *MockConn) LocalAddr() net.Addr

LocalAddr mocks base method.

func (*MockConn) Logf 

func (m *MockConn) Logf(arg0 string, arg1 ...interface{})

Logf mocks base method.

func (*MockConn) Option added in v0.2.0 

func (m *MockConn) Option(arg0 byte) Option

Option mocks base method.

func (*MockConn) Read 

func (m *MockConn) Read(arg0 []byte) (int, error)

Read mocks base method.

func (*MockConn) RemoteAddr added in v0.3.0 

func (m *MockConn) RemoteAddr() net.Addr

RemoteAddr mocks base method.

func (*MockConn) RemoveListener 

func (m *MockConn) RemoveListener(arg0 string, arg1 EventListener)

RemoveListener mocks base method.

func (*MockConn) RequestEncoding 

func (m *MockConn) RequestEncoding(arg0 encoding.Encoding) error

RequestEncoding mocks base method.

func (*MockConn) Role added in v0.3.1 

func (m *MockConn) Role() ConnRole

Role mocks base method.

func (*MockConn) Send 

func (m *MockConn) Send(arg0 []byte) (int, error)

Send mocks base method.

func (*MockConn) SetDeadline added in v0.3.0 

func (m *MockConn) SetDeadline(arg0 time.Time) error

SetDeadline mocks base method.

func (*MockConn) SetEncoding 

func (m *MockConn) SetEncoding(arg0 encoding.Encoding)

SetEncoding mocks base method.

func (*MockConn) SetLogger 

func (m *MockConn) SetLogger(arg0 Logger)

SetLogger mocks base method.

func (*MockConn) SetReadDeadline added in v0.3.0 

func (m *MockConn) SetReadDeadline(arg0 time.Time) error

SetReadDeadline mocks base method.

func (*MockConn) SetReadEncoding 

func (m *MockConn) SetReadEncoding(arg0 encoding.Encoding)

SetReadEncoding mocks base method.

func (*MockConn) SetWriteDeadline added in v0.3.0 

func (m *MockConn) SetWriteDeadline(arg0 time.Time) error

SetWriteDeadline mocks base method.

func (*MockConn) SetWriteEncoding 

func (m *MockConn) SetWriteEncoding(arg0 encoding.Encoding)

SetWriteEncoding mocks base method.

func (*MockConn) SuppressGoAhead 

func (m *MockConn) SuppressGoAhead(arg0 bool)

SuppressGoAhead mocks base method.

func (*MockConn) Write 

func (m *MockConn) Write(arg0 []byte) (int, error)

Write mocks base method.

type MockConnMockRecorder 

type MockConnMockRecorder struct {
	// contains filtered or unexported fields
}

MockConnMockRecorder is the mock recorder for MockConn.

func (*MockConnMockRecorder) AddListener 

func (mr *MockConnMockRecorder) AddListener(arg0, arg1 interface{}) *gomock.Call

AddListener indicates an expected call of AddListener.

func (*MockConnMockRecorder) BindOption 

func (mr *MockConnMockRecorder) BindOption(arg0 interface{}) *gomock.Call

BindOption indicates an expected call of BindOption.

func (*MockConnMockRecorder) Close added in v0.3.0 

func (mr *MockConnMockRecorder) Close() *gomock.Call

Close indicates an expected call of Close.

func (*MockConnMockRecorder) EnableOptionForThem 

func (mr *MockConnMockRecorder) EnableOptionForThem(arg0, arg1 interface{}) *gomock.Call

EnableOptionForThem indicates an expected call of EnableOptionForThem.

func (*MockConnMockRecorder) EnableOptionForUs 

func (mr *MockConnMockRecorder) EnableOptionForUs(arg0, arg1 interface{}) *gomock.Call

EnableOptionForUs indicates an expected call of EnableOptionForUs.

func (*MockConnMockRecorder) LocalAddr added in v0.3.0 

func (mr *MockConnMockRecorder) LocalAddr() *gomock.Call

LocalAddr indicates an expected call of LocalAddr.

func (*MockConnMockRecorder) Logf 

func (mr *MockConnMockRecorder) Logf(arg0 interface{}, arg1 ...interface{}) *gomock.Call

Logf indicates an expected call of Logf.

func (*MockConnMockRecorder) Option added in v0.2.0 

func (mr *MockConnMockRecorder) Option(arg0 interface{}) *gomock.Call

Option indicates an expected call of Option.

func (*MockConnMockRecorder) Read 

func (mr *MockConnMockRecorder) Read(arg0 interface{}) *gomock.Call

Read indicates an expected call of Read.

func (*MockConnMockRecorder) RemoteAddr added in v0.3.0 

func (mr *MockConnMockRecorder) RemoteAddr() *gomock.Call

RemoteAddr indicates an expected call of RemoteAddr.

func (*MockConnMockRecorder) RemoveListener 

func (mr *MockConnMockRecorder) RemoveListener(arg0, arg1 interface{}) *gomock.Call

RemoveListener indicates an expected call of RemoveListener.

func (*MockConnMockRecorder) RequestEncoding 

func (mr *MockConnMockRecorder) RequestEncoding(arg0 interface{}) *gomock.Call

RequestEncoding indicates an expected call of RequestEncoding.

func (*MockConnMockRecorder) Role added in v0.3.1 

func (mr *MockConnMockRecorder) Role() *gomock.Call

Role indicates an expected call of Role.

func (*MockConnMockRecorder) Send 

func (mr *MockConnMockRecorder) Send(arg0 interface{}) *gomock.Call

Send indicates an expected call of Send.

func (*MockConnMockRecorder) SetDeadline added in v0.3.0 

func (mr *MockConnMockRecorder) SetDeadline(arg0 interface{}) *gomock.Call

SetDeadline indicates an expected call of SetDeadline.

func (*MockConnMockRecorder) SetEncoding 

func (mr *MockConnMockRecorder) SetEncoding(arg0 interface{}) *gomock.Call

SetEncoding indicates an expected call of SetEncoding.

func (*MockConnMockRecorder) SetLogger 

func (mr *MockConnMockRecorder) SetLogger(arg0 interface{}) *gomock.Call

SetLogger indicates an expected call of SetLogger.

func (*MockConnMockRecorder) SetReadDeadline added in v0.3.0 

func (mr *MockConnMockRecorder) SetReadDeadline(arg0 interface{}) *gomock.Call

SetReadDeadline indicates an expected call of SetReadDeadline.

func (*MockConnMockRecorder) SetReadEncoding 

func (mr *MockConnMockRecorder) SetReadEncoding(arg0 interface{}) *gomock.Call

SetReadEncoding indicates an expected call of SetReadEncoding.

func (*MockConnMockRecorder) SetWriteDeadline added in v0.3.0 

func (mr *MockConnMockRecorder) SetWriteDeadline(arg0 interface{}) *gomock.Call

SetWriteDeadline indicates an expected call of SetWriteDeadline.

func (*MockConnMockRecorder) SetWriteEncoding 

func (mr *MockConnMockRecorder) SetWriteEncoding(arg0 interface{}) *gomock.Call

SetWriteEncoding indicates an expected call of SetWriteEncoding.

func (*MockConnMockRecorder) SuppressGoAhead 

func (mr *MockConnMockRecorder) SuppressGoAhead(arg0 interface{}) *gomock.Call

SuppressGoAhead indicates an expected call of SuppressGoAhead.

func (*MockConnMockRecorder) Write 

func (mr *MockConnMockRecorder) Write(arg0 interface{}) *gomock.Call

Write indicates an expected call of Write.

type MockEventListener added in v0.3.1 

type MockEventListener struct {
	// contains filtered or unexported fields
}

MockEventListener is a mock of EventListener interface.

func NewMockEventListener added in v0.3.1 

func NewMockEventListener(ctrl *gomock.Controller) *MockEventListener

NewMockEventListener creates a new mock instance.

func (*MockEventListener) EXPECT added in v0.3.1 

func (m *MockEventListener) EXPECT() *MockEventListenerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockEventListener) HandleEvent added in v0.3.1 

func (m *MockEventListener) HandleEvent(arg0 interface{})

HandleEvent mocks base method.

type MockEventListenerMockRecorder added in v0.3.1 

type MockEventListenerMockRecorder struct {
	// contains filtered or unexported fields
}

MockEventListenerMockRecorder is the mock recorder for MockEventListener.

func (*MockEventListenerMockRecorder) HandleEvent added in v0.3.1 

func (mr *MockEventListenerMockRecorder) HandleEvent(arg0 interface{}) *gomock.Call

HandleEvent indicates an expected call of HandleEvent.

type MockEventSink 

type MockEventSink struct {
	// contains filtered or unexported fields
}

MockEventSink is a mock of EventSink interface.

func NewMockEventSink 

func NewMockEventSink(ctrl *gomock.Controller) *MockEventSink

NewMockEventSink creates a new mock instance.

func (*MockEventSink) EXPECT 

func (m *MockEventSink) EXPECT() *MockEventSinkMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockEventSink) SendEvent 

func (m *MockEventSink) SendEvent(arg0 string, arg1 interface{})

SendEvent mocks base method.

type MockEventSinkMockRecorder 

type MockEventSinkMockRecorder struct {
	// contains filtered or unexported fields
}

MockEventSinkMockRecorder is the mock recorder for MockEventSink.

func (*MockEventSinkMockRecorder) SendEvent 

func (mr *MockEventSinkMockRecorder) SendEvent(arg0, arg1 interface{}) *gomock.Call

SendEvent indicates an expected call of SendEvent.

type MockLogger 

type MockLogger struct {
	// contains filtered or unexported fields
}

MockLogger is a mock of Logger interface.

func NewMockLogger 

func NewMockLogger(ctrl *gomock.Controller) *MockLogger

NewMockLogger creates a new mock instance.

func (*MockLogger) EXPECT 

func (m *MockLogger) EXPECT() *MockLoggerMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockLogger) Logf 

func (m *MockLogger) Logf(arg0 string, arg1 ...interface{})

Logf mocks base method.

type MockLoggerMockRecorder 

type MockLoggerMockRecorder struct {
	// contains filtered or unexported fields
}

MockLoggerMockRecorder is the mock recorder for MockLogger.

func (*MockLoggerMockRecorder) Logf 

func (mr *MockLoggerMockRecorder) Logf(arg0 interface{}, arg1 ...interface{}) *gomock.Call

Logf indicates an expected call of Logf.

type MockOption 

type MockOption struct {
	// contains filtered or unexported fields
}

MockOption is a mock of Option interface.

func NewMockOption 

func NewMockOption(ctrl *gomock.Controller) *MockOption

NewMockOption creates a new mock instance.

func (*MockOption) Allow 

func (m *MockOption) Allow(arg0, arg1 bool)

Allow mocks base method.

func (*MockOption) Bind 

func (m *MockOption) Bind(arg0 Conn, arg1 EventSink)

Bind mocks base method.

func (*MockOption) Byte 

func (m *MockOption) Byte() byte

Byte mocks base method.

func (*MockOption) Conn 

func (m *MockOption) Conn() Conn

Conn mocks base method.

func (*MockOption) EXPECT 

func (m *MockOption) EXPECT() *MockOptionMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockOption) EnabledForThem 

func (m *MockOption) EnabledForThem() bool

EnabledForThem mocks base method.

func (*MockOption) EnabledForUs 

func (m *MockOption) EnabledForUs() bool

EnabledForUs mocks base method.

func (*MockOption) Sink 

func (m *MockOption) Sink() EventSink

Sink mocks base method.

func (*MockOption) Subnegotiation 

func (m *MockOption) Subnegotiation(arg0 []byte)

Subnegotiation mocks base method.

type MockOptionMockRecorder 

type MockOptionMockRecorder struct {
	// contains filtered or unexported fields
}

MockOptionMockRecorder is the mock recorder for MockOption.

func (*MockOptionMockRecorder) Allow 

func (mr *MockOptionMockRecorder) Allow(arg0, arg1 interface{}) *gomock.Call

Allow indicates an expected call of Allow.

func (*MockOptionMockRecorder) Bind 

func (mr *MockOptionMockRecorder) Bind(arg0, arg1 interface{}) *gomock.Call

Bind indicates an expected call of Bind.

func (*MockOptionMockRecorder) Byte 

func (mr *MockOptionMockRecorder) Byte() *gomock.Call

Byte indicates an expected call of Byte.

func (*MockOptionMockRecorder) Conn 

func (mr *MockOptionMockRecorder) Conn() *gomock.Call

Conn indicates an expected call of Conn.

func (*MockOptionMockRecorder) EnabledForThem 

func (mr *MockOptionMockRecorder) EnabledForThem() *gomock.Call

EnabledForThem indicates an expected call of EnabledForThem.

func (*MockOptionMockRecorder) EnabledForUs 

func (mr *MockOptionMockRecorder) EnabledForUs() *gomock.Call

EnabledForUs indicates an expected call of EnabledForUs.

func (*MockOptionMockRecorder) Sink 

func (mr *MockOptionMockRecorder) Sink() *gomock.Call

Sink indicates an expected call of Sink.

func (*MockOptionMockRecorder) Subnegotiation 

func (mr *MockOptionMockRecorder) Subnegotiation(arg0 interface{}) *gomock.Call

Subnegotiation indicates an expected call of Subnegotiation.

type NullLogger 

type NullLogger struct{}

func (NullLogger) Logf 

func (NullLogger) Logf(string, ...any)

type Option 

type Option interface {
	Allow(them, us bool)
	Bind(Conn, EventSink)
	Byte() byte
	Conn() Conn
	Sink() EventSink
	EnabledForThem() bool
	EnabledForUs() bool
	Subnegotiation([]byte)
	// contains filtered or unexported methods
}

type SuppressGoAheadOption 

type SuppressGoAheadOption struct {
	Option
}

func NewSuppressGoAheadOption 

func NewSuppressGoAheadOption() *SuppressGoAheadOption

func (*SuppressGoAheadOption) Bind added in v0.2.0 

func (o *SuppressGoAheadOption) Bind(conn Conn, sink EventSink)

func (*SuppressGoAheadOption) HandleEvent added in v0.2.0 

func (o *SuppressGoAheadOption) HandleEvent(data any)

func (*SuppressGoAheadOption) Subnegotiation 

func (o *SuppressGoAheadOption) Subnegotiation([]byte)

type TransmitBinaryOption 

type TransmitBinaryOption struct {
	Option
}

func NewTransmitBinaryOption 

func NewTransmitBinaryOption() *TransmitBinaryOption

func (*TransmitBinaryOption) Bind added in v0.2.0 

func (t *TransmitBinaryOption) Bind(conn Conn, sink EventSink)

func (*TransmitBinaryOption) HandleEvent added in v0.2.0 

func (t *TransmitBinaryOption) HandleEvent(data any)

func (*TransmitBinaryOption) Subnegotiation 

func (t *TransmitBinaryOption) Subnegotiation(_ []byte)

type UpdateOptionEvent added in v0.2.0 

type UpdateOptionEvent struct {
	Option
	TheyChanged bool
	WeChanged   bool
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.