SoulFire LogoSoulFire

SoulFireProtocol

Public Python members of SoulFireProtocol.

Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.

Methods decorated with @fn return effects. Their implementation signatures use EffectGen for the generator body. Compose them with yield from inside a scoped workflow.

info

@fn("SoulFireProtocol.info")
def info(
    self, *, timeout_ms: int | None = None
) -> EffectGen[BotProtocolInfo, SoulFireOperationError]

Source

schemas

@fn("SoulFireProtocol.schemas")
def schemas(
    self, direction: PacketDirection, *, timeout_ms: int | None = None
) -> EffectGen[list[PacketSchema], SoulFireOperationError]

Source

packets

def packets(
    self,
    *,
    directions: Iterable[PacketDirection] = (),
    names: Iterable[str] = (),
    include_encoded_packet: bool = False,
    maximum_encoded_bytes: int = 0,
    timeout_ms: int | None = None,
) -> Stream[RawPacketEvent, SoulFireOperationError]

Source

send

@fn("SoulFireProtocol.send")
def send(
    self,
    encoded_packet: bytes,
    *,
    expected_name: str | None = None,
    timeout_ms: int | None = None,
) -> EffectGen[SendRawPacketResponse, SoulFireOperationError]

Source

How is this page?

Last updated on

On this page