GitHub

RemoteSession

API reference for RemoteSession.

What a remote's compaction client shares with the remote: its authentication.

Functions

request

request[A, E](method, identity, effect) -> Effect[A, EventLogRemoteError]

Authenticate, run effect, and authenticate again after a refusal.

ParameterTypeDescription
methodstr
identityIdentityService
effectEffect[A, E]

Returns Effect[A, EventLogRemoteError]

def request[A, E](
    self, method: str, identity: IdentityService, effect: Effect[A, E], /
) -> Effect[A, EventLogRemoteError]:
    """Authenticate, run ``effect``, and authenticate again after a
    refusal."""
    ...

framed

framed[A, E, E2](method, identity, frames, decode) -> Stream[A, EventLogRemoteError]

Authenticate, then join and decode a framed response stream.

ParameterTypeDescription
methodstr
identityIdentityService
framesCallable[[], Stream[SingleMessage | ChunkedMessage, E]]
decodeCallable[[bytes], Effect[Iterable[A], E2]]

Returns Stream[A, EventLogRemoteError]

def framed[A, E, E2](
    self,
    method: str,
    identity: IdentityService,
    frames: Callable[[], Stream[SingleMessage | ChunkedMessage, E]],
    decode: Callable[[bytes], Effect[Iterable[A], E2]],
    /,
) -> Stream[A, EventLogRemoteError]:
    """Authenticate, then join and decode a framed response stream."""
    ...