gateway

package module

v0.0.0-...-7f4bee4 Latest Latest Go to latest Published: Apr 5, 2024 License: BSD-3-Clause Imports: 0 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/tatsuworks/gateway

Links

Open Source Insights

README ¶

gateway

Service for multiplexing many Discord websockets on top of any number of backends. Consists of 2 components: Gateway & State Cache

NOTE: This currently only supports Tatsu's specific use case. More backends will be written in the future as time permits.

A custom ETF parser was written from the ground up. During peak traffic, gateway uses ~4 cores for 720 shards.

State is stored in foundationdb and accessed via the State Cache (cmd/state).

Events are pushed to redis using RPUSH. The content is the d key of the event encoded as ETF.

Common Dependencies

Ensure you have Go 1.13 or higher.
Install foundationdb (both the server and clients package).
Install redis.

Setting up the Gateway

Add a variable in cmd/gateway/main.go named Token that contains your token.
Enable modules export GO111MODULE=on
Run go build in cmd/gateway
To run, do ./gateway in cmd/gateway
To only push certain event types to the event queue, set the WHITELIST_EVENTS environment variable e.g WHITELIST_EVENTS=MESSAGE_CREATE,MESSAGE_REACTION_ADD

Setting up the State

Run go build in cmd/state
To run, do ./state in cmd/state

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Event ¶

type Event struct {
	Data []byte
	Op   int
	Seq  int
	Type string
}

type Exporter ¶

type Exporter interface {
}

type Receiver ¶

type Receiver interface {
	Receive(*Event) error
}

Receiver receives events from a Discord websocket. Receivers must make sure to not handle events asynchronously since events must be handled in order per connection. Receivers must copy Events if it will be used after returning.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
forceidentify
gateway
gatewayc
requestmembers
state
discord
discordetf
discordjson
gatewaypb
handler
internal
gatewayws
manager
state
state/api
state/db/statefdb
state/db/statepsql
statequeue

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL