soulfire.protocol_connect.BotProtocolServiceSync

class soulfire.protocol_connect.BotProtocolServiceSync

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

get_protocol_info(request: soulfire.protocol_pb2.BotProtocolRequest, ctx: connectrpc.request.RequestContext[soulfire.protocol_pb2.BotProtocolRequest, soulfire.protocol_pb2.BotProtocolInfo]) → soulfire.protocol_pb2.BotProtocolInfo

list_packet_schemas(request: soulfire.protocol_pb2.ListPacketSchemasRequest, ctx: connectrpc.request.RequestContext[soulfire.protocol_pb2.ListPacketSchemasRequest, soulfire.protocol_pb2.ListPacketSchemasResponse]) → soulfire.protocol_pb2.ListPacketSchemasResponse

watch_packets(request: soulfire.protocol_pb2.WatchPacketsRequest, ctx: connectrpc.request.RequestContext[soulfire.protocol_pb2.WatchPacketsRequest, soulfire.protocol_pb2.RawPacketEvent]) → collections.abc.Iterator[soulfire.protocol_pb2.RawPacketEvent]

send_raw_packet(request: soulfire.protocol_pb2.SendRawPacketRequest, ctx: connectrpc.request.RequestContext[soulfire.protocol_pb2.SendRawPacketRequest, soulfire.protocol_pb2.SendRawPacketResponse]) → soulfire.protocol_pb2.SendRawPacketResponse