irc

Documentation

Index

• type IRCClient
  • func NewClient(username, oauth, channel, addr string, f filter.Filter) IRCClient

Types

type IRCClient

type IRCClient interface {
	// Chat send message (`PRIVMSG`) to a channel
	Chat(m string)

	// Receive return a read-only channel that receive a message
	// in from an IRC channel
	Receive() <-chan *message.Payload

	// Pong handle `PING` message sent by the server
	Pong()

	// Username return the username of this bot
	Username() string

	// Channel return a channel name this client connect to
	Channel() string
}

IRCClient

func NewClient

func NewClient(username, oauth, channel, addr string, f filter.Filter) IRCClient

NewClient open an IRC connection using `net.Dial` with `tcp` connection. After connection has been established, it continue authenticate the connection and join a channel