lib

Documentation

Index

• Constants
• Variables
• func IRCLineToAnsi(line string, colorLevel ColorLevel, outputItalics bool) string
• func IRCMessageToAnsi(message string, colorLevel ColorLevel, outputItalics bool) string
• func ReadScript(filename string) (commands []string, err error)
• func ReplaceControlCodes(line string) string
• type ColorLevel
• type ConnectionConfig
• type IRCConnection
  • func NewConnection(config ConnectionConfig) (conn IRCConnection, err error)
  • func NewIRCWebSocket(wsUrl, origin string, tlsConfig *tls.Config) (IRCConnection, error)
• type IRCWebSocket
  • func (w *IRCWebSocket) Disconnect()
  • func (w *IRCWebSocket) GetLine() (string, error)
  • func (w *IRCWebSocket) RemoteAddr() net.Addr
  • func (w *IRCWebSocket) SendLine(line string) error
• type Socket
  • func ConnectSocket(host string, port int, useTLS bool, tlsConfig *tls.Config) (*Socket, error)
  • func MakeSocket(conn net.Conn) *Socket
  • func (s *Socket) Disconnect()
  • func (s *Socket) GetLine() (string, error)
  • func (s *Socket) RemoteAddr() net.Addr
  • func (s *Socket) SendLine(line string) error
• type Transcript
  • func NewTranscript(filename string) (result *Transcript, err error)
  • func (t *Transcript) Close() error
  • func (t *Transcript) WriteLine(line string, isClient bool) (err error)

Constants

const (
	InitialBufferSize = 1024
	MaxBufferSize     = 1024 * 1024
)

const (
	// SemVer is the semantic version of this program
	SemVer = "0.5.2"
)

Variables

var (
	// ErrorDisconnected indicates that this socket is disconnected.
	ErrorDisconnected = errors.New("Socket is disconnected")
)

Functions

func IRCLineToAnsi

func IRCLineToAnsi(line string, colorLevel ColorLevel, outputItalics bool) string

func IRCMessageToAnsi

func IRCMessageToAnsi(message string, colorLevel ColorLevel, outputItalics bool) string

func ReadScript

func ReadScript(filename string) (commands []string, err error)

func ReplaceControlCodes

func ReplaceControlCodes(line string) string

ReplaceControlCodes applies our control code replacements to the line.

Types

type ColorLevel

type ColorLevel int

ColorLevel represents the ANSI color level supported by the terminal.

const (
	// None represents a terminal that does not support color at all.
	ColorLevelNone ColorLevel = 0
	// Basic represents a terminal with basic 16 color support.
	ColorLevelBasic ColorLevel = 1
	// Ansi256 represents a terminal with 256 color support.
	ColorLevelAnsi256 ColorLevel = 2
	// Ansi16m represents a terminal with full true color support.
	ColorLevelAnsi16m ColorLevel = 3
)

type ConnectionConfig

type ConnectionConfig struct {
	// host-port pair for IRC over a normal stream transport
	Host string
	Port int
	// wss:// or ws:// URL for IRC over WebSocket
	WebsocketURL string
	TLS          bool
	TLSConfig    *tls.Config
	// Origin header for websockets
	Origin string
}

type IRCConnection

type IRCConnection interface {
	// SendLine sends an IRC protocol line, given without \r\n
	SendLine(string) error
	// GetLine reads and returns an IRC protocol line, stripping the \r\n
	GetLine() (string, error)
	// Disconnect closes the connection, interrupting GetLine(); it must be
	// concurrency-safe and idempotent.
	Disconnect()
	RemoteAddr() net.Addr
}

IRCConnection is an abstract IRC connection.

func NewConnection

func NewConnection(config ConnectionConfig) (conn IRCConnection, err error)

func NewIRCWebSocket

func NewIRCWebSocket(wsUrl, origin string, tlsConfig *tls.Config) (IRCConnection, error)

type IRCWebSocket

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

func (*IRCWebSocket) Disconnect

func (w *IRCWebSocket) Disconnect()

func (*IRCWebSocket) GetLine

func (w *IRCWebSocket) GetLine() (string, error)

func (*IRCWebSocket) RemoteAddr

func (w *IRCWebSocket) RemoteAddr() net.Addr

func (*IRCWebSocket) SendLine

func (w *IRCWebSocket) SendLine(line string) error

type Socket

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

Socket appropriately buffers IRC lines.

func ConnectSocket

func ConnectSocket(host string, port int, useTLS bool, tlsConfig *tls.Config) (*Socket, error)

ConnectSocket connects to the given host/port and starts our receivers if appropriate.

func MakeSocket

func MakeSocket(conn net.Conn) *Socket

MakeSocket makes a socket from the given connection.

func (*Socket) Disconnect

func (s *Socket) Disconnect()

Disconnect severs our connection to the server.

func (*Socket) GetLine

func (s *Socket) GetLine() (string, error)

GetLine returns a single IRC line from the socket.

func (*Socket) RemoteAddr

func (s *Socket) RemoteAddr() net.Addr

func (*Socket) SendLine

func (s *Socket) SendLine(line string) error

SendLine sends a single IRC line to the socket

type Transcript

type Transcript struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewTranscript

func NewTranscript(filename string) (result *Transcript, err error)

func (*Transcript) Close

func (t *Transcript) Close() error

func (*Transcript) WriteLine

func (t *Transcript) WriteLine(line string, isClient bool) (err error)