package
1.3.14
Repository: https://github.com/diamondburned/arikawa.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
ErrBrokenConnection marks the given error as a broken connection error.
No description provided by the author
IsBrokenConnection returns true if the error is a broken connection error.
New creates a default Websocket with the given address.
NewConn creates a new default websocket connection with a default dialer.
NewConn creates a new default websocket connection with a custom dialer.
NewCustom creates a new undialed Websocket.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WaitForEvent blocks until fn() returns true.

# Variables

CloseDeadline controls the deadline to wait for sending the Close frame.
CopyBufferSize is used for the initial size of the internal WS' buffer.
No description provided by the author
ErrWebsocketClosed is returned if the websocket is already closed.
MaxCapUntilReset determines the maximum capacity before the bytes buffer is re-allocated.
WSBuffer is the size of the Event channel.
WSDebug is used for extra debug logging.
WSError is the default error handler.
WSTimeout is the timeout for connecting and writing to the Websocket, before Gateway cancels and fails.

# Structs

Conn is the default Websocket connection.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PacemakerLoop provides an event loop with a pacemaker.
Websocket is a wrapper around a websocket Conn with thread safety and rate limiting for sending and throttling.

# Interfaces

Connection is an interface that abstracts around a generic Websocket driver.
No description provided by the author
TODO API.

# Type aliases

OPCode is a generic type for websocket OP codes.