telnet

Documentation

Index

• type Telnet
  • func New(ctx context.Context, config config.Telnet) (*Telnet, error)
  • func (t *Telnet) Connect(ctx context.Context) error
  • func (t *Telnet) Disconnect(ctx context.Context) error
  • func (t *Telnet) IsConnected() bool
  • func (t *Telnet) Send(ctx context.Context, source string, author string, channelID int, ...) error
  • func (t *Telnet) Subscribe(ctx context.Context, ...) error

Types

type Telnet

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

Telnet represents a telnet connection

func New

func New(ctx context.Context, config config.Telnet) (*Telnet, error)

New creates a new telnet connect

func (*Telnet) Connect

func (t *Telnet) Connect(ctx context.Context) error

Connect establishes a new connection with Telnet

func (*Telnet) Disconnect

func (t *Telnet) Disconnect(ctx context.Context) error

Disconnect stops a previously started connection with Telnet. If called while a connection is not active, returns nil

func (*Telnet) IsConnected

func (t *Telnet) IsConnected() bool

IsConnected returns if a connection is established

func (*Telnet) Send

func (t *Telnet) Send(ctx context.Context, source string, author string, channelID int, message string) error

Send attempts to send a message through Telnet.

func (*Telnet) Subscribe

func (t *Telnet) Subscribe(ctx context.Context, onMessage func(source string, author string, channelID int, message string)) error

Subscribe listens for new events on telnet