shard

README

Shard

Basic shard implementation utilizing the gateway package.

Documentation

Index

• type FrameError
  • func (e *FrameError) Error() string
• type Shard
  • func NewShard(shardID gateway.ShardID, botToken string, handler gateway.Handler, ...) (*Shard, error)
  • func (s *Shard) Close() error
  • func (s *Shard) CloseWithReconnectIntent() error
  • func (s *Shard) Dial(ctx context.Context, URLString string) (connection net.Conn, err error)
  • func (s *Shard) EventLoop(ctx context.Context) error
  • func (s *Shard) PrepareForReconnect() error
  • func (s *Shard) Write(op command.Type, data []byte) error
• type ShardConfig
• type WebsocketError
  • func (e *WebsocketError) Error() string
  • func (e *WebsocketError) Unwrap() error

Types

type FrameError

type FrameError struct {
	Unwanted bool
	Err      error
}

func (*FrameError) Error

func (e *FrameError) Error() string

type Shard

type Shard struct {
	Conn  net.Conn
	State *gateway.GatewayState
	// contains filtered or unexported fields
}

func NewShard

func NewShard(shardID gateway.ShardID, botToken string, handler gateway.Handler, options ...gateway.Option) (*Shard, error)

func (*Shard) Close

func (s *Shard) Close() error

Close closes the shard connection, session can not be resumed.

func (*Shard) CloseWithReconnectIntent

func (s *Shard) CloseWithReconnectIntent() error

CloseWithReconnectIntent closes the shard connection, but allows the session to be resumed later on.

func (*Shard) Dial

func (s *Shard) Dial(ctx context.Context, URLString string) (connection net.Conn, err error)

Dial sets up the websocket connection before identifying with the gateway. The url must be complete and specify api version and encoding:

"wss://gateway.discord.gg/"                     => invalid
"wss://gateway.discord.gg/?v=10"                 => invalid
"wss://gateway.discord.gg/?v=10&encoding=json"   => valid

func (*Shard) EventLoop

func (s *Shard) EventLoop(ctx context.Context) error

func (*Shard) PrepareForReconnect

func (s *Shard) PrepareForReconnect() error

func (*Shard) Write

func (s *Shard) Write(op command.Type, data []byte) error

type ShardConfig

type ShardConfig struct {
	BotToken string

	ShardID             uint
	TotalNumberOfShards uint

	IdentifyProperties gateway.IdentifyConnectionProperties

	GuildEvents []event.Type
	DMEvents    []event.Type

	CommandRateLimitChan <-chan int
	IdentifyRateLimiter  gateway.IdentifyRateLimiter

	// Intents does not have to be specified as these are derived from GuildEvents
	// and DMEvents. However, you can specify intents and it will be merged with the derived intents.
	Intents intent.Type
}

type WebsocketError

type WebsocketError struct {
	Err error
}

func (*WebsocketError) Error

func (e *WebsocketError) Error() string

func (*WebsocketError) Unwrap

func (e *WebsocketError) Unwrap() error