eventstoredb.client.subscribe_to_persistent_subscription_to_stream.mixin#

Module Contents#

Classes#

SubscribeToPersistentSubscriptionToStreamMixin

Base class for protocol classes.

RequestQueue

PersistentSubscription

class eventstoredb.client.subscribe_to_persistent_subscription_to_stream.mixin.SubscribeToPersistentSubscriptionToStreamMixin[source]#

Bases: eventstoredb.client.protocol.ClientProtocol

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:
        ...
subscribe_to_persistent_subscription_to_stream(stream_name, group_name, options=None)[source]#
Parameters:
Return type:

PersistentSubscription

class eventstoredb.client.subscribe_to_persistent_subscription_to_stream.mixin.RequestQueue[source]#

Bases: collections.abc.AsyncIterator[eventstoredb.generated.event_store.client.persistent_subscriptions.ReadReq], asyncio.Queue[eventstoredb.generated.event_store.client.persistent_subscriptions.ReadReq]

__aiter__()[source]#
Return type:

collections.abc.AsyncIterator[eventstoredb.generated.event_store.client.persistent_subscriptions.ReadReq]

async __anext__()[source]#

Return the next item or raise StopAsyncIteration when exhausted.

Return type:

eventstoredb.generated.event_store.client.persistent_subscriptions.ReadReq

class eventstoredb.client.subscribe_to_persistent_subscription_to_stream.mixin.PersistentSubscription(channel, read_request)[source]#

Bases: collections.abc.AsyncIterator[eventstoredb.events.PersistentSubscriptionEvent]

Parameters:
__aiter__()[source]#
Return type:

collections.abc.AsyncIterator[eventstoredb.events.PersistentSubscriptionEvent]

async __anext__()[source]#

Return the next item or raise StopAsyncIteration when exhausted.

Return type:

eventstoredb.events.PersistentSubscriptionEvent

async ack(events)[source]#
Parameters:

events (eventstoredb.events.PersistentSubscriptionEvent | list[eventstoredb.events.PersistentSubscriptionEvent]) –

Return type:

None

async nack(action, reason, events)[source]#
Parameters:
Return type:

None