mirror of
https://github.com/diamondburned/arikawa.git
synced 2024-11-05 06:26:08 +00:00
54cadd2f45
This commit refactors the whole package gateway as well as utils/ws
(formerly utils/wsutil) and voice/voicegateway. The new refactor
utilizes a design pattern involving a concurrent loop and an arriving
event channel.
An additional change was made to the way gateway events are typed.
Before, pretty much any type will satisfy a gateway event type, since
the actual type was just interface{}. The new refactor defines a
concrete interface that events can implement:
type Event interface {
Op() OpCode
EventType() EventType
}
Using this interface, the user can easily add custom gateway events
independently of the library without relying on string maps. This adds a
lot of type safety into the library and makes type-switching on Event
types much more reasonable.
Gateway error callbacks are also almost entirely removed in favor of
custom gateway events. A catch-all can easily be added like this:
s.AddHandler(func(err error) {
log.Println("gateway error:, err")
})
40 lines
1.2 KiB
Go
40 lines
1.2 KiB
Go
package api
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/diamondburned/arikawa/v3/discord"
|
|
"github.com/diamondburned/arikawa/v3/utils/httputil"
|
|
)
|
|
|
|
// BotData contains the GatewayURL as well as extra metadata on how to
|
|
// shard bots.
|
|
type BotData struct {
|
|
URL string `json:"url"`
|
|
Shards int `json:"shards,omitempty"`
|
|
StartLimit *SessionStartLimit `json:"session_start_limit"`
|
|
}
|
|
|
|
// SessionStartLimit is the information on the current session start limit. It's
|
|
// used in BotData.
|
|
type SessionStartLimit struct {
|
|
Total int `json:"total"`
|
|
Remaining int `json:"remaining"`
|
|
ResetAfter discord.Milliseconds `json:"reset_after"`
|
|
MaxConcurrency int `json:"max_concurrency"`
|
|
}
|
|
|
|
// BotURL fetches the Gateway URL along with extra metadata. The token
|
|
// passed in will NOT be prefixed with Bot.
|
|
func (c *Client) BotURL() (*BotData, error) {
|
|
var g *BotData
|
|
return g, c.RequestJSON(&g, "GET", EndpointGatewayBot)
|
|
}
|
|
|
|
// GatewayURL asks Discord for a Websocket URL to the Gateway.
|
|
func GatewayURL(ctx context.Context) (string, error) {
|
|
var g BotData
|
|
err := httputil.NewClient().WithContext(ctx).RequestJSON(&g, "GET", EndpointGateway)
|
|
return g.URL, err
|
|
}
|