irc

Documentation

Index

• Constants
• func ParseTags(msg string) (map[string]string, int, error)
• type Client
  • func New(username string, oauth string, openConnLimiter func()) *Client
  • func (c *Client) Connect(ctx context.Context) error
  • func (c *Client) IsConnected() bool
  • func (c *Client) SetOAuth(oauth string)
  • func (c *Client) SetOnConnect(f func())
  • func (c *Client) SetOnMessage(f func(Message))
  • func (c *Client) SetOnReconnect(f func())
  • func (c *Client) Shutdown()
  • func (c *Client) Write(msg string) error
• type IrcTags
  • func (i IrcTags) Banned() bool
  • func (i IrcTags) ChannelSuspended() bool
  • func (i IrcTags) MessageID() string
• type Message
  • func ParseMessage(line string) (Message, error)
• type MessageType
  • func ToMessageType(s string) MessageType

Constants

const (
	MessageTypePrivmsg         = "PRIVMSG"
	MessageTypeNotice          = "NOTICE"
	MessageTypePing            = "PING"
	MessageTypePong            = "PONG"
	MessageTypeCap             = "CAP"
	MessageType001             = "001"
	MessageType002             = "002"
	MessageType003             = "003"
	MessageType004             = "004"
	MessageType353             = "353"
	MessageType366             = "366"
	MessageType372             = "372"
	MessageType375             = "375"
	MessageType376             = "376"
	MessageTypeUnknown         = "UNKNOWN"
	MessageTypeJoin            = "JOIN"
	MessageTypePart            = "PART"
	MessageTypeGlobalUserState = "GLOBALUSERSTATE"
	MessageTypeWhisper         = "WHISPER"
	MessageTypeRoomState       = "ROOMSTATE"
	MessageTypeUserState       = "USERSTATE"
	MessageTypeClearChat       = "CLEARCHAT"
	MessageTypeReconnect       = "RECONNECT"
	MessageTypeUserNotice      = "USERNOTICE"

	MsgIdChannelSuspended = "msg_channel_suspended"
	MsgIdBanned           = "msg_banned"
)

Functions

func ParseTags

func ParseTags(msg string) (map[string]string, int, error)

Types

type Client

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

func New

func New(username string, oauth string, openConnLimiter func()) *Client

func (*Client) Connect

func (c *Client) Connect(ctx context.Context) error

func (*Client) IsConnected

func (c *Client) IsConnected() bool

func (*Client) SetOAuth

func (c *Client) SetOAuth(oauth string)

func (*Client) SetOnConnect

func (c *Client) SetOnConnect(f func())

func (*Client) SetOnMessage

func (c *Client) SetOnMessage(f func(Message))

func (*Client) SetOnReconnect

func (c *Client) SetOnReconnect(f func())

func (*Client) Shutdown

func (c *Client) Shutdown()

func (*Client) Write

func (c *Client) Write(msg string) error

type IrcTags

type IrcTags map[string]string

func (IrcTags) Banned

func (i IrcTags) Banned() bool

func (IrcTags) ChannelSuspended

func (i IrcTags) ChannelSuspended() bool

func (IrcTags) MessageID

func (i IrcTags) MessageID() string

type Message

type Message struct {
	Raw     string
	Source  string
	Type    MessageType
	Channel string
	User    string
	Content string
	Tags    IrcTags
}

func ParseMessage

func ParseMessage(line string) (Message, error)

type MessageType

type MessageType string

func ToMessageType

func ToMessageType(s string) MessageType