o

ackcord

DiscordShard

object DiscordShard

Source
DiscordShard.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DiscordShard
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. sealed trait Command extends AnyRef
  2. case class FetchWSGatewayBotInfo(gateway: Uri, shards: Int, sessionStartLimits: SessionStartLimits) extends Product with Serializable
  3. case class Parameters(gatewayUri: Uri, settings: GatewaySettings, events: Events, context: ActorContext[Command], timers: TimerScheduler[Command], log: Logger) extends Product with Serializable
  4. case class SessionStartLimits(total: Int, remaining: Int, resetAfter: Duration, maxConcurrency: Int) extends Product with Serializable
  5. case class State(gatewayHandler: ActorRef[gateway.GatewayHandler.Command], isShuttingDown: Boolean = false, isRestarting: Boolean = false) extends Product with Serializable

Value Members

  1. def apply(wsUri: Uri, settings: GatewaySettings, events: Events): Behavior[Command]

    The core actor that controls all the other used actors of AckCord

    The core actor that controls all the other used actors of AckCord

    wsUri

    The gateway websocket uri

    settings

    The settings to use

    events

    The events instance to use for this shard

  2. def fetchWsGateway(implicit system: ActorSystem[Nothing]): Future[Uri]

    Fetch the websocket gateway.

    Fetch the websocket gateway.

    system

    The actor system to use.

    returns

    An URI with the websocket gateway uri.

  3. def fetchWsGatewayWithShards(token: String)(implicit system: ActorSystem[Nothing]): Future[FetchWSGatewayBotInfo]

    Fetch the websocket gateway with information about how many shards should be used.

    Fetch the websocket gateway with information about how many shards should be used.

    system

    The actor system to use.

    returns

    An URI with the websocket gateway uri.

  4. def many(wsUri: Uri, shardTotal: Int, settings: GatewaySettings, events: Events): Seq[Behavior[Command]]

    Create many shard actors, given the needed arguments.

    Create many shard actors, given the needed arguments.

    wsUri

    The websocket gateway uri.

    shardTotal

    The amount of shards to create.

    settings

    The settings to use.

  5. def startShards(shards: Seq[ActorRef[Command]])(implicit system: ActorSystem[Nothing]): Future[Done]

    Sends a login message to all the shards in the sequence, while obeying IDENTIFY ratelimits.

  6. case object RestartShard extends Command with Product with Serializable

    Send this to log out and log in again this shard.

  7. case object StartShard extends Command with Product with Serializable

    Send this to the client to log in.

  8. case object StopShard extends Command with Product with Serializable

    Send this to the client to log out and stop gracefully.