shard

Documentation

Index

• Constants
• type DiscordCloseCode
  • func (d DiscordCloseCode) String() string
• type Heartbeat
  • func NewHeartbeat(interval int64, shard *Shard, logger zerolog.Logger) *Heartbeat
  • func (h *Heartbeat) ACK()
  • func (h *Heartbeat) SendHeartbeat() error
  • func (h *Heartbeat) Start()
  • func (h *Heartbeat) Stop()
• type IdentifyLocker
• type ReadResult
• type Shard
  • func New(token string, opts ...ShardOption) *Shard
  • func (s *Shard) Close()
  • func (s *Shard) IsIdentified() bool
  • func (s *Shard) Latency() time.Duration
  • func (s *Shard) MarshalZerologObject(e *zerolog.Event)
  • func (s *Shard) Run() error
  • func (s *Shard) Send(op objects.OpCode, data interface{}) error
  • func (s *Shard) String() string
• type ShardError
  • func (s ShardError) Error() string
• type ShardOption
  • func WithDispatcher(d dispatcher.Dispatcher) ShardOption
  • func WithGatewayURL(u string) ShardOption
  • func WithIdentifyLock(l IdentifyLocker) ShardOption
  • func WithInitialPresence(p objects.UpdatePresence) ShardOption
  • func WithIntents(i objects.Intent) ShardOption
  • func WithLogger(l zerolog.Logger) ShardOption
  • func WithShardInfo(id, count int) ShardOption
• type Websocket
  • func NewWebsocket(logger *zerolog.Logger) *Websocket
  • func (w *Websocket) Close() error
  • func (w *Websocket) IsConnected() bool
  • func (w *Websocket) Open(ctx context.Context, endpoint string, requestHeader http.Header) (err error)
  • func (w *Websocket) Read(ctx context.Context) (data []byte, err error)
  • func (w *Websocket) WriteJSON(v interface{}) error

Constants

const (
	GatewayDefaultURL = "wss://gateway.discord.gg/"
	GatewayVersion    = 10
	GatewayEncoding   = "json"
	GatewayAddressFmt = "%s/?v=%d&encoding=%s"
)

Types

type DiscordCloseCode

type DiscordCloseCode int64

const (
	CloseUnknownError DiscordCloseCode = iota + 4000
	CloseUnknownOpcode
	CloseDecodeError
	CloseNotAuthenticated
	CloseAuthenticationFailed
	CloseAlreadyAuthenticated

	CloseInvalidSeq
	CloseRateLimited
	CloseSessionTimeout
	CloseInvalidShard
	CloseShardingRequired
	CloseInvalidAPIVersion
	CloseInvalidIntents
	CloseDisallowedIntents
)

func (DiscordCloseCode) String

func (d DiscordCloseCode) String() string

type Heartbeat

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

func NewHeartbeat

func NewHeartbeat(interval int64, shard *Shard, logger zerolog.Logger) *Heartbeat

func (*Heartbeat) ACK

func (h *Heartbeat) ACK()

func (*Heartbeat) SendHeartbeat

func (h *Heartbeat) SendHeartbeat() error

func (*Heartbeat) Start

func (h *Heartbeat) Start()

func (*Heartbeat) Stop

func (h *Heartbeat) Stop()

type IdentifyLocker

type IdentifyLocker interface {
	Lock()
	Unlock()
}

type ReadResult

type ReadResult struct {
	Payload objects.Payload
	Err     error
}

type Shard

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

Shard represents a single Shard connection

func New

func New(token string, opts ...ShardOption) *Shard

func (*Shard) Close

func (s *Shard) Close()

func (*Shard) IsIdentified

func (s *Shard) IsIdentified() bool

func (*Shard) Latency

func (s *Shard) Latency() time.Duration

func (*Shard) MarshalZerologObject

func (s *Shard) MarshalZerologObject(e *zerolog.Event)

func (*Shard) Run

func (s *Shard) Run() error

func (*Shard) Send

func (s *Shard) Send(op objects.OpCode, data interface{}) error

func (*Shard) String

func (s *Shard) String() string

type ShardError

type ShardError struct {
	Message string
}

func (ShardError) Error

func (s ShardError) Error() string

type ShardOption

type ShardOption func(*Shard)

func WithDispatcher

func WithDispatcher(d dispatcher.Dispatcher) ShardOption

func WithGatewayURL

func WithGatewayURL(u string) ShardOption

func WithIdentifyLock

func WithIdentifyLock(l IdentifyLocker) ShardOption

func WithInitialPresence

func WithInitialPresence(p objects.UpdatePresence) ShardOption

func WithIntents

func WithIntents(i objects.Intent) ShardOption

func WithLogger

func WithLogger(l zerolog.Logger) ShardOption

func WithShardInfo

func WithShardInfo(id, count int) ShardOption

type Websocket

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

func NewWebsocket

func NewWebsocket(logger *zerolog.Logger) *Websocket

func (*Websocket) Close

func (w *Websocket) Close() error

func (*Websocket) IsConnected

func (w *Websocket) IsConnected() bool

func (*Websocket) Open

func (w *Websocket) Open(ctx context.Context, endpoint string, requestHeader http.Header) (err error)

func (*Websocket) Read

func (w *Websocket) Read(ctx context.Context) (data []byte, err error)

func (*Websocket) WriteJSON

func (w *Websocket) WriteJSON(v interface{}) error