telnet

package module
v0.3.3 Latest Latest
Warning

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

Go to latest
Published: Jun 29, 2024 License: MIT Imports: 11 Imported by: 3

README

telnet

a telnet library for go

Documentation

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 {
	mock.Mock
}

MockConn is an autogenerated mock type for the Conn type

func NewMockConn

func NewMockConn(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockConn

NewMockConn creates a new instance of MockConn. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockConn) AddListener

func (_m *MockConn) AddListener(_a0 string, _a1 EventListener)

AddListener provides a mock function with given fields: _a0, _a1

func (*MockConn) BindOption

func (_m *MockConn) BindOption(o Option)

BindOption provides a mock function with given fields: o

func (*MockConn) Close added in v0.3.0

func (_m *MockConn) Close() error

Close provides a mock function with given fields:

func (*MockConn) EXPECT

func (_m *MockConn) EXPECT() *MockConn_Expecter

func (*MockConn) EnableOptionForThem

func (_m *MockConn) EnableOptionForThem(option byte, enable bool) error

EnableOptionForThem provides a mock function with given fields: option, enable

func (*MockConn) EnableOptionForUs

func (_m *MockConn) EnableOptionForUs(option byte, enable bool) error

EnableOptionForUs provides a mock function with given fields: option, enable

func (*MockConn) LocalAddr added in v0.3.0

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

LocalAddr provides a mock function with given fields:

func (*MockConn) Logf

func (_m *MockConn) Logf(fmt string, v ...interface{})

Logf provides a mock function with given fields: fmt, v

func (*MockConn) Option added in v0.2.0

func (_m *MockConn) Option(option byte) Option

Option provides a mock function with given fields: option

func (*MockConn) Read

func (_m *MockConn) Read(b []byte) (int, error)

Read provides a mock function with given fields: b

func (*MockConn) RemoteAddr added in v0.3.0

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

RemoteAddr provides a mock function with given fields:

func (*MockConn) RemoveListener

func (_m *MockConn) RemoveListener(_a0 string, _a1 EventListener)

RemoveListener provides a mock function with given fields: _a0, _a1

func (*MockConn) RequestEncoding

func (_m *MockConn) RequestEncoding(_a0 encoding.Encoding) error

RequestEncoding provides a mock function with given fields: _a0

func (*MockConn) Role added in v0.3.1

func (_m *MockConn) Role() ConnRole

Role provides a mock function with given fields:

func (*MockConn) Send

func (_m *MockConn) Send(p []byte) (int, error)

Send provides a mock function with given fields: p

func (*MockConn) SetDeadline added in v0.3.0

func (_m *MockConn) SetDeadline(t time.Time) error

SetDeadline provides a mock function with given fields: t

func (*MockConn) SetEncoding

func (_m *MockConn) SetEncoding(_a0 encoding.Encoding)

SetEncoding provides a mock function with given fields: _a0

func (*MockConn) SetLogger

func (_m *MockConn) SetLogger(_a0 Logger)

SetLogger provides a mock function with given fields: _a0

func (*MockConn) SetReadDeadline added in v0.3.0

func (_m *MockConn) SetReadDeadline(t time.Time) error

SetReadDeadline provides a mock function with given fields: t

func (*MockConn) SetReadEncoding

func (_m *MockConn) SetReadEncoding(_a0 encoding.Encoding)

SetReadEncoding provides a mock function with given fields: _a0

func (*MockConn) SetWriteDeadline added in v0.3.0

func (_m *MockConn) SetWriteDeadline(t time.Time) error

SetWriteDeadline provides a mock function with given fields: t

func (*MockConn) SetWriteEncoding

func (_m *MockConn) SetWriteEncoding(_a0 encoding.Encoding)

SetWriteEncoding provides a mock function with given fields: _a0

func (*MockConn) SuppressGoAhead

func (_m *MockConn) SuppressGoAhead(enabled bool)

SuppressGoAhead provides a mock function with given fields: enabled

func (*MockConn) Write

func (_m *MockConn) Write(b []byte) (int, error)

Write provides a mock function with given fields: b

type MockConn_AddListener_Call added in v0.3.3

type MockConn_AddListener_Call struct {
	*mock.Call
}

MockConn_AddListener_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'AddListener'

func (*MockConn_AddListener_Call) Return added in v0.3.3

func (*MockConn_AddListener_Call) Run added in v0.3.3

func (*MockConn_AddListener_Call) RunAndReturn added in v0.3.3

type MockConn_BindOption_Call added in v0.3.3

type MockConn_BindOption_Call struct {
	*mock.Call
}

MockConn_BindOption_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'BindOption'

func (*MockConn_BindOption_Call) Return added in v0.3.3

func (*MockConn_BindOption_Call) Run added in v0.3.3

func (*MockConn_BindOption_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_BindOption_Call) RunAndReturn(run func(Option)) *MockConn_BindOption_Call

type MockConn_Close_Call added in v0.3.3

type MockConn_Close_Call struct {
	*mock.Call
}

MockConn_Close_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Close'

func (*MockConn_Close_Call) Return added in v0.3.3

func (*MockConn_Close_Call) Run added in v0.3.3

func (_c *MockConn_Close_Call) Run(run func()) *MockConn_Close_Call

func (*MockConn_Close_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_Close_Call) RunAndReturn(run func() error) *MockConn_Close_Call

type MockConn_EnableOptionForThem_Call added in v0.3.3

type MockConn_EnableOptionForThem_Call struct {
	*mock.Call
}

MockConn_EnableOptionForThem_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'EnableOptionForThem'

func (*MockConn_EnableOptionForThem_Call) Return added in v0.3.3

func (*MockConn_EnableOptionForThem_Call) Run added in v0.3.3

func (*MockConn_EnableOptionForThem_Call) RunAndReturn added in v0.3.3

type MockConn_EnableOptionForUs_Call added in v0.3.3

type MockConn_EnableOptionForUs_Call struct {
	*mock.Call
}

MockConn_EnableOptionForUs_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'EnableOptionForUs'

func (*MockConn_EnableOptionForUs_Call) Return added in v0.3.3

func (*MockConn_EnableOptionForUs_Call) Run added in v0.3.3

func (_c *MockConn_EnableOptionForUs_Call) Run(run func(option byte, enable bool)) *MockConn_EnableOptionForUs_Call

func (*MockConn_EnableOptionForUs_Call) RunAndReturn added in v0.3.3

type MockConn_Expecter added in v0.3.3

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

func (*MockConn_Expecter) AddListener added in v0.3.3

func (_e *MockConn_Expecter) AddListener(_a0 interface{}, _a1 interface{}) *MockConn_AddListener_Call

AddListener is a helper method to define mock.On call

  • _a0 string
  • _a1 EventListener

func (*MockConn_Expecter) BindOption added in v0.3.3

func (_e *MockConn_Expecter) BindOption(o interface{}) *MockConn_BindOption_Call

BindOption is a helper method to define mock.On call

  • o Option

func (*MockConn_Expecter) Close added in v0.3.3

Close is a helper method to define mock.On call

func (*MockConn_Expecter) EnableOptionForThem added in v0.3.3

func (_e *MockConn_Expecter) EnableOptionForThem(option interface{}, enable interface{}) *MockConn_EnableOptionForThem_Call

EnableOptionForThem is a helper method to define mock.On call

  • option byte
  • enable bool

func (*MockConn_Expecter) EnableOptionForUs added in v0.3.3

func (_e *MockConn_Expecter) EnableOptionForUs(option interface{}, enable interface{}) *MockConn_EnableOptionForUs_Call

EnableOptionForUs is a helper method to define mock.On call

  • option byte
  • enable bool

func (*MockConn_Expecter) LocalAddr added in v0.3.3

func (_e *MockConn_Expecter) LocalAddr() *MockConn_LocalAddr_Call

LocalAddr is a helper method to define mock.On call

func (*MockConn_Expecter) Logf added in v0.3.3

func (_e *MockConn_Expecter) Logf(fmt interface{}, v ...interface{}) *MockConn_Logf_Call

Logf is a helper method to define mock.On call

  • fmt string
  • v ...interface{}

func (*MockConn_Expecter) Option added in v0.3.3

func (_e *MockConn_Expecter) Option(option interface{}) *MockConn_Option_Call

Option is a helper method to define mock.On call

  • option byte

func (*MockConn_Expecter) Read added in v0.3.3

func (_e *MockConn_Expecter) Read(b interface{}) *MockConn_Read_Call

Read is a helper method to define mock.On call

  • b []byte

func (*MockConn_Expecter) RemoteAddr added in v0.3.3

func (_e *MockConn_Expecter) RemoteAddr() *MockConn_RemoteAddr_Call

RemoteAddr is a helper method to define mock.On call

func (*MockConn_Expecter) RemoveListener added in v0.3.3

func (_e *MockConn_Expecter) RemoveListener(_a0 interface{}, _a1 interface{}) *MockConn_RemoveListener_Call

RemoveListener is a helper method to define mock.On call

  • _a0 string
  • _a1 EventListener

func (*MockConn_Expecter) RequestEncoding added in v0.3.3

func (_e *MockConn_Expecter) RequestEncoding(_a0 interface{}) *MockConn_RequestEncoding_Call

RequestEncoding is a helper method to define mock.On call

  • _a0 encoding.Encoding

func (*MockConn_Expecter) Role added in v0.3.3

Role is a helper method to define mock.On call

func (*MockConn_Expecter) Send added in v0.3.3

func (_e *MockConn_Expecter) Send(p interface{}) *MockConn_Send_Call

Send is a helper method to define mock.On call

  • p []byte

func (*MockConn_Expecter) SetDeadline added in v0.3.3

func (_e *MockConn_Expecter) SetDeadline(t interface{}) *MockConn_SetDeadline_Call

SetDeadline is a helper method to define mock.On call

  • t time.Time

func (*MockConn_Expecter) SetEncoding added in v0.3.3

func (_e *MockConn_Expecter) SetEncoding(_a0 interface{}) *MockConn_SetEncoding_Call

SetEncoding is a helper method to define mock.On call

  • _a0 encoding.Encoding

func (*MockConn_Expecter) SetLogger added in v0.3.3

func (_e *MockConn_Expecter) SetLogger(_a0 interface{}) *MockConn_SetLogger_Call

SetLogger is a helper method to define mock.On call

  • _a0 Logger

func (*MockConn_Expecter) SetReadDeadline added in v0.3.3

func (_e *MockConn_Expecter) SetReadDeadline(t interface{}) *MockConn_SetReadDeadline_Call

SetReadDeadline is a helper method to define mock.On call

  • t time.Time

func (*MockConn_Expecter) SetReadEncoding added in v0.3.3

func (_e *MockConn_Expecter) SetReadEncoding(_a0 interface{}) *MockConn_SetReadEncoding_Call

SetReadEncoding is a helper method to define mock.On call

  • _a0 encoding.Encoding

func (*MockConn_Expecter) SetWriteDeadline added in v0.3.3

func (_e *MockConn_Expecter) SetWriteDeadline(t interface{}) *MockConn_SetWriteDeadline_Call

SetWriteDeadline is a helper method to define mock.On call

  • t time.Time

func (*MockConn_Expecter) SetWriteEncoding added in v0.3.3

func (_e *MockConn_Expecter) SetWriteEncoding(_a0 interface{}) *MockConn_SetWriteEncoding_Call

SetWriteEncoding is a helper method to define mock.On call

  • _a0 encoding.Encoding

func (*MockConn_Expecter) SuppressGoAhead added in v0.3.3

func (_e *MockConn_Expecter) SuppressGoAhead(enabled interface{}) *MockConn_SuppressGoAhead_Call

SuppressGoAhead is a helper method to define mock.On call

  • enabled bool

func (*MockConn_Expecter) Write added in v0.3.3

func (_e *MockConn_Expecter) Write(b interface{}) *MockConn_Write_Call

Write is a helper method to define mock.On call

  • b []byte

type MockConn_LocalAddr_Call added in v0.3.3

type MockConn_LocalAddr_Call struct {
	*mock.Call
}

MockConn_LocalAddr_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'LocalAddr'

func (*MockConn_LocalAddr_Call) Return added in v0.3.3

func (*MockConn_LocalAddr_Call) Run added in v0.3.3

func (_c *MockConn_LocalAddr_Call) Run(run func()) *MockConn_LocalAddr_Call

func (*MockConn_LocalAddr_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_LocalAddr_Call) RunAndReturn(run func() net.Addr) *MockConn_LocalAddr_Call

type MockConn_Logf_Call added in v0.3.3

type MockConn_Logf_Call struct {
	*mock.Call
}

MockConn_Logf_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Logf'

func (*MockConn_Logf_Call) Return added in v0.3.3

func (_c *MockConn_Logf_Call) Return() *MockConn_Logf_Call

func (*MockConn_Logf_Call) Run added in v0.3.3

func (_c *MockConn_Logf_Call) Run(run func(fmt string, v ...interface{})) *MockConn_Logf_Call

func (*MockConn_Logf_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_Logf_Call) RunAndReturn(run func(string, ...interface{})) *MockConn_Logf_Call

type MockConn_Option_Call added in v0.3.3

type MockConn_Option_Call struct {
	*mock.Call
}

MockConn_Option_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Option'

func (*MockConn_Option_Call) Return added in v0.3.3

func (*MockConn_Option_Call) Run added in v0.3.3

func (_c *MockConn_Option_Call) Run(run func(option byte)) *MockConn_Option_Call

func (*MockConn_Option_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_Option_Call) RunAndReturn(run func(byte) Option) *MockConn_Option_Call

type MockConn_Read_Call added in v0.3.3

type MockConn_Read_Call struct {
	*mock.Call
}

MockConn_Read_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Read'

func (*MockConn_Read_Call) Return added in v0.3.3

func (_c *MockConn_Read_Call) Return(n int, err error) *MockConn_Read_Call

func (*MockConn_Read_Call) Run added in v0.3.3

func (_c *MockConn_Read_Call) Run(run func(b []byte)) *MockConn_Read_Call

func (*MockConn_Read_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_Read_Call) RunAndReturn(run func([]byte) (int, error)) *MockConn_Read_Call

type MockConn_RemoteAddr_Call added in v0.3.3

type MockConn_RemoteAddr_Call struct {
	*mock.Call
}

MockConn_RemoteAddr_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoteAddr'

func (*MockConn_RemoteAddr_Call) Return added in v0.3.3

func (*MockConn_RemoteAddr_Call) Run added in v0.3.3

func (*MockConn_RemoteAddr_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_RemoteAddr_Call) RunAndReturn(run func() net.Addr) *MockConn_RemoteAddr_Call

type MockConn_RemoveListener_Call added in v0.3.3

type MockConn_RemoveListener_Call struct {
	*mock.Call
}

MockConn_RemoveListener_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RemoveListener'

func (*MockConn_RemoveListener_Call) Return added in v0.3.3

func (*MockConn_RemoveListener_Call) Run added in v0.3.3

func (*MockConn_RemoveListener_Call) RunAndReturn added in v0.3.3

type MockConn_RequestEncoding_Call added in v0.3.3

type MockConn_RequestEncoding_Call struct {
	*mock.Call
}

MockConn_RequestEncoding_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'RequestEncoding'

func (*MockConn_RequestEncoding_Call) Return added in v0.3.3

func (*MockConn_RequestEncoding_Call) Run added in v0.3.3

func (*MockConn_RequestEncoding_Call) RunAndReturn added in v0.3.3

type MockConn_Role_Call added in v0.3.3

type MockConn_Role_Call struct {
	*mock.Call
}

MockConn_Role_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Role'

func (*MockConn_Role_Call) Return added in v0.3.3

func (*MockConn_Role_Call) Run added in v0.3.3

func (_c *MockConn_Role_Call) Run(run func()) *MockConn_Role_Call

func (*MockConn_Role_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_Role_Call) RunAndReturn(run func() ConnRole) *MockConn_Role_Call

type MockConn_Send_Call added in v0.3.3

type MockConn_Send_Call struct {
	*mock.Call
}

MockConn_Send_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Send'

func (*MockConn_Send_Call) Return added in v0.3.3

func (_c *MockConn_Send_Call) Return(n int, err error) *MockConn_Send_Call

func (*MockConn_Send_Call) Run added in v0.3.3

func (_c *MockConn_Send_Call) Run(run func(p []byte)) *MockConn_Send_Call

func (*MockConn_Send_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_Send_Call) RunAndReturn(run func([]byte) (int, error)) *MockConn_Send_Call

type MockConn_SetDeadline_Call added in v0.3.3

type MockConn_SetDeadline_Call struct {
	*mock.Call
}

MockConn_SetDeadline_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SetDeadline'

func (*MockConn_SetDeadline_Call) Return added in v0.3.3

func (*MockConn_SetDeadline_Call) Run added in v0.3.3

func (*MockConn_SetDeadline_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_SetDeadline_Call) RunAndReturn(run func(time.Time) error) *MockConn_SetDeadline_Call

type MockConn_SetEncoding_Call added in v0.3.3

type MockConn_SetEncoding_Call struct {
	*mock.Call
}

MockConn_SetEncoding_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SetEncoding'

func (*MockConn_SetEncoding_Call) Return added in v0.3.3

func (*MockConn_SetEncoding_Call) Run added in v0.3.3

func (*MockConn_SetEncoding_Call) RunAndReturn added in v0.3.3

type MockConn_SetLogger_Call added in v0.3.3

type MockConn_SetLogger_Call struct {
	*mock.Call
}

MockConn_SetLogger_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SetLogger'

func (*MockConn_SetLogger_Call) Return added in v0.3.3

func (*MockConn_SetLogger_Call) Run added in v0.3.3

func (_c *MockConn_SetLogger_Call) Run(run func(_a0 Logger)) *MockConn_SetLogger_Call

func (*MockConn_SetLogger_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_SetLogger_Call) RunAndReturn(run func(Logger)) *MockConn_SetLogger_Call

type MockConn_SetReadDeadline_Call added in v0.3.3

type MockConn_SetReadDeadline_Call struct {
	*mock.Call
}

MockConn_SetReadDeadline_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SetReadDeadline'

func (*MockConn_SetReadDeadline_Call) Return added in v0.3.3

func (*MockConn_SetReadDeadline_Call) Run added in v0.3.3

func (*MockConn_SetReadDeadline_Call) RunAndReturn added in v0.3.3

type MockConn_SetReadEncoding_Call added in v0.3.3

type MockConn_SetReadEncoding_Call struct {
	*mock.Call
}

MockConn_SetReadEncoding_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SetReadEncoding'

func (*MockConn_SetReadEncoding_Call) Return added in v0.3.3

func (*MockConn_SetReadEncoding_Call) Run added in v0.3.3

func (*MockConn_SetReadEncoding_Call) RunAndReturn added in v0.3.3

type MockConn_SetWriteDeadline_Call added in v0.3.3

type MockConn_SetWriteDeadline_Call struct {
	*mock.Call
}

MockConn_SetWriteDeadline_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SetWriteDeadline'

func (*MockConn_SetWriteDeadline_Call) Return added in v0.3.3

func (*MockConn_SetWriteDeadline_Call) Run added in v0.3.3

func (*MockConn_SetWriteDeadline_Call) RunAndReturn added in v0.3.3

type MockConn_SetWriteEncoding_Call added in v0.3.3

type MockConn_SetWriteEncoding_Call struct {
	*mock.Call
}

MockConn_SetWriteEncoding_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SetWriteEncoding'

func (*MockConn_SetWriteEncoding_Call) Return added in v0.3.3

func (*MockConn_SetWriteEncoding_Call) Run added in v0.3.3

func (*MockConn_SetWriteEncoding_Call) RunAndReturn added in v0.3.3

type MockConn_SuppressGoAhead_Call added in v0.3.3

type MockConn_SuppressGoAhead_Call struct {
	*mock.Call
}

MockConn_SuppressGoAhead_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SuppressGoAhead'

func (*MockConn_SuppressGoAhead_Call) Return added in v0.3.3

func (*MockConn_SuppressGoAhead_Call) Run added in v0.3.3

func (*MockConn_SuppressGoAhead_Call) RunAndReturn added in v0.3.3

type MockConn_Write_Call added in v0.3.3

type MockConn_Write_Call struct {
	*mock.Call
}

MockConn_Write_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Write'

func (*MockConn_Write_Call) Return added in v0.3.3

func (_c *MockConn_Write_Call) Return(n int, err error) *MockConn_Write_Call

func (*MockConn_Write_Call) Run added in v0.3.3

func (_c *MockConn_Write_Call) Run(run func(b []byte)) *MockConn_Write_Call

func (*MockConn_Write_Call) RunAndReturn added in v0.3.3

func (_c *MockConn_Write_Call) RunAndReturn(run func([]byte) (int, error)) *MockConn_Write_Call

type MockEventListener added in v0.3.1

type MockEventListener struct {
	mock.Mock
}

MockEventListener is an autogenerated mock type for the EventListener type

func NewMockEventListener added in v0.3.1

func NewMockEventListener(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockEventListener

NewMockEventListener creates a new instance of MockEventListener. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockEventListener) EXPECT added in v0.3.1

func (*MockEventListener) HandleEvent added in v0.3.1

func (_m *MockEventListener) HandleEvent(_a0 interface{})

HandleEvent provides a mock function with given fields: _a0

type MockEventListener_Expecter added in v0.3.3

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

func (*MockEventListener_Expecter) HandleEvent added in v0.3.3

func (_e *MockEventListener_Expecter) HandleEvent(_a0 interface{}) *MockEventListener_HandleEvent_Call

HandleEvent is a helper method to define mock.On call

  • _a0 interface{}

type MockEventListener_HandleEvent_Call added in v0.3.3

type MockEventListener_HandleEvent_Call struct {
	*mock.Call
}

MockEventListener_HandleEvent_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'HandleEvent'

func (*MockEventListener_HandleEvent_Call) Return added in v0.3.3

func (*MockEventListener_HandleEvent_Call) Run added in v0.3.3

func (_c *MockEventListener_HandleEvent_Call) Run(run func(_a0 interface{})) *MockEventListener_HandleEvent_Call

func (*MockEventListener_HandleEvent_Call) RunAndReturn added in v0.3.3

func (_c *MockEventListener_HandleEvent_Call) RunAndReturn(run func(interface{})) *MockEventListener_HandleEvent_Call

type MockEventSink

type MockEventSink struct {
	mock.Mock
}

MockEventSink is an autogenerated mock type for the EventSink type

func NewMockEventSink

func NewMockEventSink(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockEventSink

NewMockEventSink creates a new instance of MockEventSink. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockEventSink) EXPECT

func (_m *MockEventSink) EXPECT() *MockEventSink_Expecter

func (*MockEventSink) SendEvent

func (_m *MockEventSink) SendEvent(event string, data interface{})

SendEvent provides a mock function with given fields: event, data

type MockEventSink_Expecter added in v0.3.3

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

func (*MockEventSink_Expecter) SendEvent added in v0.3.3

func (_e *MockEventSink_Expecter) SendEvent(event interface{}, data interface{}) *MockEventSink_SendEvent_Call

SendEvent is a helper method to define mock.On call

  • event string
  • data interface{}

type MockEventSink_SendEvent_Call added in v0.3.3

type MockEventSink_SendEvent_Call struct {
	*mock.Call
}

MockEventSink_SendEvent_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'SendEvent'

func (*MockEventSink_SendEvent_Call) Return added in v0.3.3

func (*MockEventSink_SendEvent_Call) Run added in v0.3.3

func (_c *MockEventSink_SendEvent_Call) Run(run func(event string, data interface{})) *MockEventSink_SendEvent_Call

func (*MockEventSink_SendEvent_Call) RunAndReturn added in v0.3.3

func (_c *MockEventSink_SendEvent_Call) RunAndReturn(run func(string, interface{})) *MockEventSink_SendEvent_Call

type MockLogger

type MockLogger struct {
	mock.Mock
}

MockLogger is an autogenerated mock type for the Logger type

func NewMockLogger

func NewMockLogger(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockLogger

NewMockLogger creates a new instance of MockLogger. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockLogger) EXPECT

func (_m *MockLogger) EXPECT() *MockLogger_Expecter

func (*MockLogger) Logf

func (_m *MockLogger) Logf(fmt string, v ...interface{})

Logf provides a mock function with given fields: fmt, v

type MockLogger_Expecter added in v0.3.3

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

func (*MockLogger_Expecter) Logf added in v0.3.3

func (_e *MockLogger_Expecter) Logf(fmt interface{}, v ...interface{}) *MockLogger_Logf_Call

Logf is a helper method to define mock.On call

  • fmt string
  • v ...interface{}

type MockLogger_Logf_Call added in v0.3.3

type MockLogger_Logf_Call struct {
	*mock.Call
}

MockLogger_Logf_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Logf'

func (*MockLogger_Logf_Call) Return added in v0.3.3

func (*MockLogger_Logf_Call) Run added in v0.3.3

func (_c *MockLogger_Logf_Call) Run(run func(fmt string, v ...interface{})) *MockLogger_Logf_Call

func (*MockLogger_Logf_Call) RunAndReturn added in v0.3.3

func (_c *MockLogger_Logf_Call) RunAndReturn(run func(string, ...interface{})) *MockLogger_Logf_Call

type MockOption

type MockOption struct {
	mock.Mock
}

MockOption is an autogenerated mock type for the Option type

func NewMockOption

func NewMockOption(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockOption

NewMockOption creates a new instance of MockOption. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockOption) Allow

func (_m *MockOption) Allow(them bool, us bool)

Allow provides a mock function with given fields: them, us

func (*MockOption) Bind

func (_m *MockOption) Bind(_a0 Conn, _a1 EventSink)

Bind provides a mock function with given fields: _a0, _a1

func (*MockOption) Byte

func (_m *MockOption) Byte() byte

Byte provides a mock function with given fields:

func (*MockOption) Conn

func (_m *MockOption) Conn() Conn

Conn provides a mock function with given fields:

func (*MockOption) EXPECT

func (_m *MockOption) EXPECT() *MockOption_Expecter

func (*MockOption) EnabledForThem

func (_m *MockOption) EnabledForThem() bool

EnabledForThem provides a mock function with given fields:

func (*MockOption) EnabledForUs

func (_m *MockOption) EnabledForUs() bool

EnabledForUs provides a mock function with given fields:

func (*MockOption) Sink

func (_m *MockOption) Sink() EventSink

Sink provides a mock function with given fields:

func (*MockOption) Subnegotiation

func (_m *MockOption) Subnegotiation(_a0 []byte)

Subnegotiation provides a mock function with given fields: _a0

type MockOption_Allow_Call added in v0.3.3

type MockOption_Allow_Call struct {
	*mock.Call
}

MockOption_Allow_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Allow'

func (*MockOption_Allow_Call) Return added in v0.3.3

func (*MockOption_Allow_Call) Run added in v0.3.3

func (_c *MockOption_Allow_Call) Run(run func(them bool, us bool)) *MockOption_Allow_Call

func (*MockOption_Allow_Call) RunAndReturn added in v0.3.3

func (_c *MockOption_Allow_Call) RunAndReturn(run func(bool, bool)) *MockOption_Allow_Call

type MockOption_Bind_Call added in v0.3.3

type MockOption_Bind_Call struct {
	*mock.Call
}

MockOption_Bind_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Bind'

func (*MockOption_Bind_Call) Return added in v0.3.3

func (*MockOption_Bind_Call) Run added in v0.3.3

func (_c *MockOption_Bind_Call) Run(run func(_a0 Conn, _a1 EventSink)) *MockOption_Bind_Call

func (*MockOption_Bind_Call) RunAndReturn added in v0.3.3

func (_c *MockOption_Bind_Call) RunAndReturn(run func(Conn, EventSink)) *MockOption_Bind_Call

type MockOption_Byte_Call added in v0.3.3

type MockOption_Byte_Call struct {
	*mock.Call
}

MockOption_Byte_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Byte'

func (*MockOption_Byte_Call) Return added in v0.3.3

func (*MockOption_Byte_Call) Run added in v0.3.3

func (_c *MockOption_Byte_Call) Run(run func()) *MockOption_Byte_Call

func (*MockOption_Byte_Call) RunAndReturn added in v0.3.3

func (_c *MockOption_Byte_Call) RunAndReturn(run func() byte) *MockOption_Byte_Call

type MockOption_Conn_Call added in v0.3.3

type MockOption_Conn_Call struct {
	*mock.Call
}

MockOption_Conn_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Conn'

func (*MockOption_Conn_Call) Return added in v0.3.3

func (*MockOption_Conn_Call) Run added in v0.3.3

func (_c *MockOption_Conn_Call) Run(run func()) *MockOption_Conn_Call

func (*MockOption_Conn_Call) RunAndReturn added in v0.3.3

func (_c *MockOption_Conn_Call) RunAndReturn(run func() Conn) *MockOption_Conn_Call

type MockOption_EnabledForThem_Call added in v0.3.3

type MockOption_EnabledForThem_Call struct {
	*mock.Call
}

MockOption_EnabledForThem_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'EnabledForThem'

func (*MockOption_EnabledForThem_Call) Return added in v0.3.3

func (*MockOption_EnabledForThem_Call) Run added in v0.3.3

func (*MockOption_EnabledForThem_Call) RunAndReturn added in v0.3.3

type MockOption_EnabledForUs_Call added in v0.3.3

type MockOption_EnabledForUs_Call struct {
	*mock.Call
}

MockOption_EnabledForUs_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'EnabledForUs'

func (*MockOption_EnabledForUs_Call) Return added in v0.3.3

func (*MockOption_EnabledForUs_Call) Run added in v0.3.3

func (*MockOption_EnabledForUs_Call) RunAndReturn added in v0.3.3

func (_c *MockOption_EnabledForUs_Call) RunAndReturn(run func() bool) *MockOption_EnabledForUs_Call

type MockOption_Expecter added in v0.3.3

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

func (*MockOption_Expecter) Allow added in v0.3.3

func (_e *MockOption_Expecter) Allow(them interface{}, us interface{}) *MockOption_Allow_Call

Allow is a helper method to define mock.On call

  • them bool
  • us bool

func (*MockOption_Expecter) Bind added in v0.3.3

func (_e *MockOption_Expecter) Bind(_a0 interface{}, _a1 interface{}) *MockOption_Bind_Call

Bind is a helper method to define mock.On call

  • _a0 Conn
  • _a1 EventSink

func (*MockOption_Expecter) Byte added in v0.3.3

Byte is a helper method to define mock.On call

func (*MockOption_Expecter) Conn added in v0.3.3

Conn is a helper method to define mock.On call

func (*MockOption_Expecter) EnabledForThem added in v0.3.3

EnabledForThem is a helper method to define mock.On call

func (*MockOption_Expecter) EnabledForUs added in v0.3.3

EnabledForUs is a helper method to define mock.On call

func (*MockOption_Expecter) Sink added in v0.3.3

Sink is a helper method to define mock.On call

func (*MockOption_Expecter) Subnegotiation added in v0.3.3

func (_e *MockOption_Expecter) Subnegotiation(_a0 interface{}) *MockOption_Subnegotiation_Call

Subnegotiation is a helper method to define mock.On call

  • _a0 []byte

type MockOption_Sink_Call added in v0.3.3

type MockOption_Sink_Call struct {
	*mock.Call
}

MockOption_Sink_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Sink'

func (*MockOption_Sink_Call) Return added in v0.3.3

func (*MockOption_Sink_Call) Run added in v0.3.3

func (_c *MockOption_Sink_Call) Run(run func()) *MockOption_Sink_Call

func (*MockOption_Sink_Call) RunAndReturn added in v0.3.3

func (_c *MockOption_Sink_Call) RunAndReturn(run func() EventSink) *MockOption_Sink_Call

type MockOption_Subnegotiation_Call added in v0.3.3

type MockOption_Subnegotiation_Call struct {
	*mock.Call
}

MockOption_Subnegotiation_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Subnegotiation'

func (*MockOption_Subnegotiation_Call) Return added in v0.3.3

func (*MockOption_Subnegotiation_Call) Run added in v0.3.3

func (*MockOption_Subnegotiation_Call) RunAndReturn added in v0.3.3

type MockOption_disableThem_Call added in v0.3.3

type MockOption_disableThem_Call struct {
	*mock.Call
}

MockOption_disableThem_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'disableThem'

func (*MockOption_disableThem_Call) Return added in v0.3.3

func (*MockOption_disableThem_Call) Run added in v0.3.3

func (*MockOption_disableThem_Call) RunAndReturn added in v0.3.3

func (_c *MockOption_disableThem_Call) RunAndReturn(run func() error) *MockOption_disableThem_Call

type MockOption_disableUs_Call added in v0.3.3

type MockOption_disableUs_Call struct {
	*mock.Call
}

MockOption_disableUs_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'disableUs'

func (*MockOption_disableUs_Call) Return added in v0.3.3

func (*MockOption_disableUs_Call) Run added in v0.3.3

func (*MockOption_disableUs_Call) RunAndReturn added in v0.3.3

func (_c *MockOption_disableUs_Call) RunAndReturn(run func() error) *MockOption_disableUs_Call

type MockOption_enableThem_Call added in v0.3.3

type MockOption_enableThem_Call struct {
	*mock.Call
}

MockOption_enableThem_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'enableThem'

func (*MockOption_enableThem_Call) Return added in v0.3.3

func (*MockOption_enableThem_Call) Run added in v0.3.3

func (*MockOption_enableThem_Call) RunAndReturn added in v0.3.3

func (_c *MockOption_enableThem_Call) RunAndReturn(run func() error) *MockOption_enableThem_Call

type MockOption_enableUs_Call added in v0.3.3

type MockOption_enableUs_Call struct {
	*mock.Call
}

MockOption_enableUs_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'enableUs'

func (*MockOption_enableUs_Call) Return added in v0.3.3

func (*MockOption_enableUs_Call) Run added in v0.3.3

func (*MockOption_enableUs_Call) RunAndReturn added in v0.3.3

func (_c *MockOption_enableUs_Call) RunAndReturn(run func() error) *MockOption_enableUs_Call

type MockOption_receive_Call added in v0.3.3

type MockOption_receive_Call struct {
	*mock.Call
}

MockOption_receive_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'receive'

func (*MockOption_receive_Call) Return added in v0.3.3

func (*MockOption_receive_Call) Run added in v0.3.3

func (*MockOption_receive_Call) RunAndReturn added in v0.3.3

func (_c *MockOption_receive_Call) RunAndReturn(run func(byte) error) *MockOption_receive_Call

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
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL