soulfire.server_connect.ServerServiceSync

class soulfire.server_connect.ServerServiceSync

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_server_info(request: soulfire.server_pb2.ServerInfoRequest, ctx: connectrpc.request.RequestContext[soulfire.server_pb2.ServerInfoRequest, soulfire.server_pb2.ServerInfoResponse]) → soulfire.server_pb2.ServerInfoResponse

update_server_config(request: soulfire.server_pb2.ServerUpdateConfigRequest, ctx: connectrpc.request.RequestContext[soulfire.server_pb2.ServerUpdateConfigRequest, soulfire.server_pb2.ServerUpdateConfigResponse]) → soulfire.server_pb2.ServerUpdateConfigResponse

update_server_config_entry(request: soulfire.server_pb2.ServerUpdateConfigEntryRequest, ctx: connectrpc.request.RequestContext[soulfire.server_pb2.ServerUpdateConfigEntryRequest, soulfire.server_pb2.ServerUpdateConfigEntryResponse]) → soulfire.server_pb2.ServerUpdateConfigEntryResponse