Handlers

Handler Impl's.

The handler implemented classes.

BasicSessionHandler

BasicSessionHandler(client: Client)

Bases: handler_.SessionHandler

Basic Session Handler.

This session handler simply fetches the first working session, and returns it. If it closes or fails, it switches to the next available one.

sessions property

sessions: typing.Sequence[Session]

The sessions attached to this handler.

players property

players: typing.Sequence[Player]

The players attached to this handler.

is_alive property

is_alive: bool

Whether the handler is alive or not.

start async

start() -> None

Start the session handler.

Starts up the session handler and attempts to connect all sessions to their websocket.

stop async

stop() -> None

Stop the session handler.

Stops the session handler and kills all players and sessions.

add_session

add_session(session: Session) -> Session

Add a session.

fetch_session

fetch_session(name: str | None = None) -> Session

Fetch a session.

Returns a valid session.

Note

If a name is provided, only that session will be attempted to be returned.

PARAMETER	DESCRIPTION
name	The name of the session. TYPE: str | None DEFAULT: None

RETURNS	DESCRIPTION
Session	The session to use.

RAISES	DESCRIPTION
NoSessionError	Raised when there is no available sessions for the handler to return.
SessionMissingError	Raised when a session is requested, but does not exist.

delete_session async

delete_session(name: str) -> None

Delete a session.

Delete a session from the session handler.

Parameters name The name of the session to delete.

RETURNS	DESCRIPTION
Session	The session that was added to the handler.

RAISES	DESCRIPTION
SessionMissingError	Raised when the session does not exist.

add_player

add_player(player: Player) -> Player

Add a player.

Add a new player to the session handler.

PARAMETER	DESCRIPTION
player	The player to add to the session handler. TYPE: Player

RETURNS	DESCRIPTION
Player	The player you added to the session handler.

fetch_player

fetch_player(
    guild: hikari.SnowflakeishOr[hikari.Guild],
) -> Player

Fetch a player.

Fetches an existing player.

PARAMETER	DESCRIPTION
guild	The guild, or guild id you wish to fetch the player for. TYPE: hikari.SnowflakeishOr[hikari.Guild]

RAISES	DESCRIPTION
PlayerMissingError	Raised when the player for the specified guild does not exist.

delete_player async

delete_player(
    guild: hikari.SnowflakeishOr[hikari.Guild],
) -> None

Delete a player.

Delete a pre-existing player.

PARAMETER	DESCRIPTION
guild	The guild, or guild id you wish to delete the player from. TYPE: hikari.SnowflakeishOr[hikari.Guild]

RAISES	DESCRIPTION
PlayerMissingError	Raised when the player for the specified guild does not exist.