irc

type Config struct {
	Host     string
	Port     uint // if 0, 6667 is used, or 6697 if SSL
	Password string

	SSL       bool // set to true to use SSL
	SSLConfig *tls.Config

	Nick     string
	User     string
	RealName string

	Timeout time.Duration // timeout for the Connect. 0 means no timeout.

	AllowFlood   bool          // set to true to disable flood protection
	PingInterval time.Duration // defaults to 3 minutes, set to -1 to disable

	// Init is called immediately after the connection is established but
	// before logging in. This is the right place to set up handlers.
	// If Init is called, Connect() will not return an error.
	// Required.
	Init func(HandlerRegistry)
	// NickInUse is called when the chosen nickname is already in use.
	// Optional.
	// It's also given the 3-digit error code provided by the server,
	// e.g. 432 indicates invalid characters in the nick, and 433 indicates
	// the nickname was already in use.
	// It must return a new nickname.
	// If nil, the default behavior of appending a _ is uesd.
	NickInUse func(oldnick string, errcode int) string
}

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

type HandlerRegistry interface {
	AddHandler(name string, f func(*Conn, Line)) callback.CallbackIdentifier
	RemoveHandler(callback.CallbackIdentifier)
}

type Line struct {
	Src     User
	Command string
	Args    []string
	Raw     string
	Time    time.Time

	// Dst is only filled in for the special commands such as ACTION, CTCP, and
	// CTCPReply. It denotes the target the PRIVMSG/NOTICE was sent to.
	Dst string
	// contains filtered or unexported fields
}

type SafeConn interface {
	// Me returns the user at the time the SafeConn was created
	Me() User
	// Server returns the host:port pair that identifies the server
	Server() string

	// Connected returns whether the connection is still connected
	Connected() bool

	// Invoke runs the given function on the connection's goroutine
	Invoke(func(*Conn)) bool

	// AddHandler is the same as Conn.AddHandler
	AddHandler(name string, f func(*Conn, Line)) callback.CallbackIdentifier

	// RemoveHandler is the same as Conn.RemoveHandler
	RemoveHandler(callback.CallbackIdentifier)

	// Conn methods
	Raw(line string) bool
	Privmsg(dst, msg string) bool
	Action(dst, msg string) bool
	Notice(dst, msg string) bool
	CTCP(dst, command, args string) bool
	CTCPReply(dst, command, args string) bool
	Quit(msg string) bool
	Nick(newnick string) bool
	Join(channels, keys []string) bool
	Part(channels []string, msg string) bool
}

type User struct {
	// Nick, User, and Host will only be present if the user is of the form
	// nick[!user]@host Notably, a server host sender will have all three fields
	// as the empty string.
	Nick, User, Host string
	Raw              string
}