irc

package module

v0.0.0-...-26182ce Latest Latest Go to latest Published: Jul 19, 2015 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

An implementation of the IRC protocol (not finished)

This section is empty.

View Source

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

View Source

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

View Source

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

This section is empty.

type Client struct {
	io.ReadWriteCloser
}

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 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 (m Message) Encode(w io.Writer) (err error)

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

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

UnmarshalText parses the IRC message into the Message struct.

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

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

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

Path	Synopsis
_example
internal
util Package util provides some helpful functions.	Package util provides some helpful functions.