irc

Documentation

Overview

Package irc is an IRC-over-websocket client implementation.

Index

• type Conn
• type Dialer
  • func New(addr string) (Dialer, error)
  • func NewTLS(addr string, options ...TLSOpt) Dialer
• type Message
  • func ParseMessage(line string) *Message
  • func (m *Message) Arg(i int) string
  • func (m *Message) Raw() string
  • func (m *Message) String() string
  • func (m *Message) Trailer(i int) string
• type TLSConfig
• type TLSOpt

Types

type Conn

type Conn interface {
	Read() (*Message, error)
	Send(string) error
	Close() error
}

A Conn is an IRC connection.

type Dialer

type Dialer interface {
	// Dial connects with a given context. The context does not (only) govern
	// the Dial itself, but also the established connection.
	Dial(context.Context) (Conn, error)
}

Dialer is a preconfigured IRC connector.

func New

func New(addr string) (Dialer, error)

New creates a new Dialer from a URL.

func NewTLS

func NewTLS(addr string, options ...TLSOpt) Dialer

NewTLS is an extended initializer for TLS-based IRC.

type Message

type Message struct {
	Tags       map[string]string `json:"tags"`
	Source     string            `json:"source"`
	Command    string            `json:"command"`
	Args       []string          `json:"args"`
	HasTrailer bool              `json:"trailer,omitempty"` // Useful to know.. usually
	// contains filtered or unexported fields
}

func ParseMessage

func ParseMessage(line string) *Message

func (*Message) Arg

func (m *Message) Arg(i int) string

Arg returns the given argument, even if it is not set.

func (*Message) Raw

func (m *Message) Raw() string

func (*Message) String

func (m *Message) String() string

func (*Message) Trailer

func (m *Message) Trailer(i int) string

Trailer returns the argument at position i, even if it is not strictly the final argument.

type TLSConfig

type TLSConfig struct{ *tls.Config }

TLSConfig is a TLSOpt for specifying a tls.Config.

type TLSOpt

type TLSOpt interface {
	// contains filtered or unexported methods
}