irc

Documentation

Index

• Constants
• func Flags(cmd *cobra.Command)
• func Init() (*chatlib.Option, error)
• type API
  • func New(opts ...Option) (*API, error)
  • func (a *API) ApplyOptions(opts ...Option) error
  • func (a *API) Ping() error
  • func (a *API) ReceiveMessage(c context.Context) (*chatlib.Message, error)
  • func (a *API) SendMessage(c context.Context, msg *chatlib.Message) error
  • func (a *API) Start(c context.Context) error
  • func (a *API) Stop(c context.Context) error
• type Option
  • func CombineOptions(opts ...Option) Option
  • func WithAuthMethod(method int) Option
  • func WithChannel(channel string) Option
  • func WithChannels(channels []string) Option
  • func WithDialTimeout(seconds float64) Option
  • func WithKeepAlive(seconds float64) Option
  • func WithMessageBufferSize(size int) Option
  • func WithNetwork(host string, port int) Option
  • func WithNick(nick string) Option
  • func WithPassword(password string) Option
  • func WithTLS(cfg *tls.Config) Option

Constants

const (
	DefaultNick                    = "freyabot"
	DefaultLoginDelaySeconds       = 5
	DefaultDialTimeoutSeconds      = 10
	DefaultKeepAliveSeconds        = 60
	DefaultMsgBufferSize           = 100
	DefaultTlsPort                 = 6697
	DefaultPlainPort               = 6667
	ReadDelimiter             byte = '\n'
)

const (
	AuthMethodNone = iota
	AuthMethodNickServ
	AuthMethodSASL
	AuthMethodCertFP
)

const ApiName = "irc"

Functions

func Flags

func Flags(cmd *cobra.Command)

func Init

func Init() (*chatlib.Option, error)

Types

type API

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

func New

func New(opts ...Option) (*API, error)

func (*API) ApplyOptions

func (a *API) ApplyOptions(opts ...Option) error

func (*API) Ping

func (a *API) Ping() error

func (*API) ReceiveMessage

func (a *API) ReceiveMessage(c context.Context) (*chatlib.Message, error)

func (*API) SendMessage

func (a *API) SendMessage(c context.Context, msg *chatlib.Message) error

TODO Handle long messages

func (*API) Start

func (a *API) Start(c context.Context) error

func (*API) Stop

func (a *API) Stop(c context.Context) error

type Option

type Option func(*API) error

func CombineOptions

func CombineOptions(opts ...Option) Option

func WithAuthMethod

func WithAuthMethod(method int) Option

func WithChannel

func WithChannel(channel string) Option

func WithChannels

func WithChannels(channels []string) Option

func WithDialTimeout

func WithDialTimeout(seconds float64) Option

func WithKeepAlive

func WithKeepAlive(seconds float64) Option

func WithMessageBufferSize

func WithMessageBufferSize(size int) Option

func WithNetwork

func WithNetwork(host string, port int) Option

func WithNick

func WithNick(nick string) Option

func WithPassword

func WithPassword(password string) Option

func WithTLS

func WithTLS(cfg *tls.Config) Option