irc

Documentation

Overview

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

Index

• type IRC
  • func New(ctx context.Context) *IRC
  • func (irc *IRC) Close() error
  • func (irc *IRC) Connect(address string) (chan *Message, error)
  • func (irc *IRC) Err() error
  • func (irc *IRC) Send(message string)
• 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

Types

type IRC

type IRC struct {
	Dialer   *websocket.Dialer
	Messages chan *Message // recv
	Outgoing chan string   // send
	// contains filtered or unexported fields
}

IRC is an IRC connection.

func New

func New(ctx context.Context) *IRC

New creates a new IRC instance for a single IRC session.

func (*IRC) Close

func (irc *IRC) Close() error

Close terminates the IRC connection and stops the sender goroutine.

func (*IRC) Connect

func (irc *IRC) Connect(address string) (chan *Message, error)

Connect to an IRC server.

func (*IRC) Err

func (irc *IRC) Err() error

Err returns the first error that occurred, if any.

func (*IRC) Send

func (irc *IRC) Send(message string)

Send queues a message to be sent to the IRC server, blocking if the queue is full.

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.