libduvet - v1.1.0

libduvet/gateway/manager

Types

Config

</>

A manager’s setup: its API client, where the gateway is, how long an attempt may take, and whether sessions resume.

pub type Config {
  Config(
    api: client.RestClient,
    router: api_router.ApiRouter,
    connect_timeout: Int,
    resume: Bool,
    platform: option.Option(client_platform.ClientPlatform),
    log: fn(Int, String) -> Nil,
    feed: feed.Feed,
  )
}

Constructors

GatewayManager

opaque </> 
pub opaque type GatewayManager

ManagerError

</>

What a manager can fail with.

pub type ManagerError {
  Destroyed
}

Constructors 

  • Destroyed

    The manager was destroyed before its shards were online.

Values

config

</> 
pub fn config(api: client.RestClient) -> Config

connect_all

</> 
pub fn connect_all(
  manager: GatewayManager,
  shard_count: Int,
) -> Result(Nil, ManagerError)

Spawns [shard_count] shards and connects each one: it returns once each has a socket open, trying again while one can’t open, and fails with [Destroyed] if the manager is destroyed first.

connection

</> 
pub fn connection(manager: GatewayManager) -> option.Option(Int)

Shard 0’s connection number, or None while it has no socket.

destroy

</> 
pub fn destroy(manager: GatewayManager) -> Nil

Permanently shuts down all shards and closes the feed.

feed

</> 
pub fn feed(manager: GatewayManager) -> feed.Feed

The manager’s feed: every shard’s events, states, resumes, closes and failures, in the order the shard published them.

retry_now

</> 
pub fn retry_now(manager: GatewayManager) -> Bool

Ends each shard’s wait before its next attempt, and answers whether one was waiting.

send_message

</> 
pub fn send_message(
  manager: GatewayManager,
  type_: String,
  data: json.Json,
) -> Result(Bool, Nil)

Sends an event message through shard 0, when one is connected.

silence_before_ready

</> 
pub fn silence_before_ready(
  manager: GatewayManager,
) -> duration.Duration

Shard 0’s silence before its last READY.

start

</> 
pub fn start(config: Config) -> GatewayManager

want_fresh_session

</> 
pub fn want_fresh_session(manager: GatewayManager) -> Nil

Makes each shard’s next identify start a new session, with READY, rather than resume its own.

with_connect_timeout

</> 
pub fn with_connect_timeout(
  config: Config,
  timeout_ms: Int,
) -> Config

with_log

</> 
pub fn with_log(
  config: Config,
  log: fn(Int, String) -> Nil,
) -> Config

with_platform

</> 
pub fn with_platform(
  config: Config,
  platform: client_platform.ClientPlatform,
) -> Config

with_resume

</> 
pub fn with_resume(config: Config, resume: Bool) -> Config

with_router

</> 
pub fn with_router(
  config: Config,
  router: api_router.ApiRouter,
) -> Config
✨ Search Document