ircconn

Documentation

Overview

Package ircconn provides transport connections that frame IRC messages, along with outbound rate limiting.

Index

• Constants
• type Conn
• type Dialer
• type Limiter
  • func (l *Limiter) Wait(ctx context.Context) error
• type RateLimit
  • func (r RateLimit) NewLimiter() *Limiter
• type TCPDialer
  • func (d *TCPDialer) Dial(ctx context.Context, addr string) (Conn, error)

Constants

const (
	// DefaultMaxLine is the default maximum length of an IRC message line in bytes.
	DefaultMaxLine = 512
	// MaxTagBytes is the maximum length of the IRC message tags section in bytes.
	MaxTagBytes = 8191
)

Types

type Conn

type Conn interface {
	ReadMessage(ctx context.Context) (ircmsg.Message, error)
	WriteMessage(ctx context.Context, m ircmsg.Message) error
	Close() error
	RemoteAddr() net.Addr
}

Conn represents a transport that frames IRC messages on the wire.

type Dialer

type Dialer interface {
	Dial(ctx context.Context, addr string) (Conn, error)
}

Dialer establishes a Conn to the given address.

type Limiter

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

Limiter gates outbound sends through a token bucket.

func (*Limiter) Wait

func (l *Limiter) Wait(ctx context.Context) error

Wait blocks until a send is permitted or ctx is cancelled.

type RateLimit

type RateLimit struct {
	Burst       int
	PerInterval time.Duration
	Disabled    bool
}

RateLimit configures outbound flood protection.

func (RateLimit) NewLimiter

func (r RateLimit) NewLimiter() *Limiter

NewLimiter returns a Limiter built from the RateLimit configuration.

type TCPDialer

type TCPDialer struct {
	NetDialer  *net.Dialer
	TLSConfig  *tls.Config
	MaxLineLen int
	Logger     *slog.Logger
}

TCPDialer dials a plain TCP connection, or a TLS connection when TLSConfig is non-nil.

func (*TCPDialer) Dial

func (d *TCPDialer) Dial(ctx context.Context, addr string) (Conn, error)

Dial establishes a Conn to addr, using TLS when TLSConfig is set.