irc

README

irc

An implementation of the IRC protocol (not finished)

Documentation

Index

• Variables
• type Client
  • func NewClient(r io.ReadWriteCloser) (c Client)
  • func (c Client) Command(command string, params ...string) error
  • func (c Client) Join(channels ...string) error
  • func (c Client) JoinLockedChannel(channel, password string) error
  • func (c Client) Nick(name string) error
  • func (c Client) Pass(password string) error
  • func (c Client) SendMessage(m Message) (err error)
• type Message
  • func (m Message) Encode(w io.Writer) (err error)
  • func (m Message) MarshalText() (b []byte, err error)
  • func (m *Message) UnmarshalText(b []byte) (err error)
• type MessageDecoder
  • func NewMessageDecoder(r io.Reader) (m MessageDecoder)
  • func (d MessageDecoder) Decode() (m Message, err error)

Variables

var ErrMsgTooLong = errors.New("irc: message longer than 510 characters")

var ErrMsgTooShort = errors.New("irc: message too short")

var ErrParamsTooLong = errors.New("irc: more than 15 parameters")

Types

type Client

type Client struct {
	io.ReadWriteCloser
}

func NewClient

func NewClient(r io.ReadWriteCloser) (c Client)

func (Client) Command

func (c Client) Command(command string, params ...string) error

func (Client) Join

func (c Client) Join(channels ...string) error

func (Client) JoinLockedChannel

func (c Client) JoinLockedChannel(channel, password string) error

func (Client) Nick

func (c Client) Nick(name string) error

func (Client) Pass

func (c Client) Pass(password string) error

func (Client) SendMessage

func (c Client) SendMessage(m Message) (err error)

type Message

type Message struct {
	Prefix  string
	Command string
	Params  []string //up to 15
}

Message represents a single IRC message, such as this:

:prefix command parameter1 param2 param3

func (Message) Encode

func (m Message) Encode(w io.Writer) (err error)

func (Message) MarshalText

func (m Message) MarshalText() (b []byte, err error)

func (*Message) UnmarshalText

func (m *Message) UnmarshalText(b []byte) (err error)

UnmarshalText parses the IRC message into the Message struct.

type MessageDecoder

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

func NewMessageDecoder

func NewMessageDecoder(r io.Reader) (m MessageDecoder)

func (MessageDecoder) Decode

func (d MessageDecoder) Decode() (m Message, err error)