Class SubscribableActor<Entity, Message, Result>`Abstract`

Type Parameters

Entity extends Document & { updated: Timestamp }
Message
Result

Hierarchy (View Summary)

StoringActor<Entity, Message, Result>
- SubscribableActor

Index

Constructors

constructor

new SubscribableActor<
    Entity extends Document & { updated: Timestamp },
    Message,
    Result,
>(
    name: string,
    system: ActorSystem,
    collectionName: string,
): SubscribableActor<Entity, Message, Result>
Type Parameters
- Entity extends Document & { updated: Timestamp }
- Message
- Result
Parameters
- name: string
- system: ActorSystem
- collectionName: string
Returns SubscribableActor<Entity, Message, Result>
Overrides StoringActor.constructor
- Defined in backend/src/actors/SubscribableActor.ts:32

Properties

`Protected` `Readonly`collectionName

collectionName: string

`Protected` `Readonly`connector

connector: DbClient = ...

`Protected` `Abstract`state

state: {
    cache: Map<string & BRAND<"UID">, Entity>;
    collectionSubscribers: Map<
        string & BRAND<"ActorUri">,
        CollecionSubscription,
    >;
    lastSeen: Map<string & BRAND<"ActorUri">, Timestamp>;
    lastTouched: Map<string & BRAND<"UID">, Timestamp>;
    subscribers: Map<string & BRAND<"UID">, Set<string & BRAND<"ActorUri">>>;
}

Methods

`Protected`afterEntityRemovedFromCache

afterEntityRemovedFromCache(_uid: string & BRAND<"UID">): Promise<void>
Parameters
- _uid: string & BRAND<"UID">
Returns Promise<void>
Inherited from StoringActor.afterEntityRemovedFromCache
- Defined in backend/src/actors/StoringActor.ts:63

`Protected`afterEntityWasCached

afterEntityWasCached(_uid: string & BRAND<"UID">): Promise<void>
Parameters
- _uid: string & BRAND<"UID">
Returns Promise<void>
Inherited from StoringActor.afterEntityWasCached
- Defined in backend/src/actors/StoringActor.ts:86

afterStart

afterStart(): Promise<void>
Runs after the actor was started and is ready to receive messages.

Returns Promise<void>
Inherited from StoringActor.afterStart
- Defined in backend/src/actors/StoringActor.ts:33

beforeShutdown

beforeShutdown(): Promise<void>
Runs before the actor gets shut down by the actor system

Returns Promise<void>
Overrides StoringActor.beforeShutdown
- Defined in backend/src/actors/SubscribableActor.ts:37

`Protected`cleanup

cleanup(): void
Returns void
Overrides StoringActor.cleanup
- Defined in backend/src/actors/SubscribableActor.ts:64

`Protected`deleteEntity

deleteEntity(uid: string & BRAND<"UID">): Promise<Unit>
Parameters
- uid: string & BRAND<"UID">
Returns Promise<Unit>
Inherited from StoringActor.deleteEntity
- Defined in backend/src/actors/StoringActor.ts:135

`Protected`determineRole

determineRole(
    from: ActorRef,
): Promise<
    [
        UserRole: AccessRole,
        UserID: string & BRAND<"UID">,
        IsTemporaryAccount: boolean,
    ],
>
Parameters
- from: ActorRef
Returns Promise<
    [
        UserRole: AccessRole,
        UserID: string & BRAND<"UID">,
        IsTemporaryAccount: boolean,
    ],
>
Inherited from StoringActor.determineRole
- Defined in backend/src/actors/StoringActor.ts:42

`Protected`getEntity

getEntity(uid: string & BRAND<"UID">): Promise<MaybeBase<Entity>>
Parameters
- uid: string & BRAND<"UID">
Returns Promise<MaybeBase<Entity>>
Inherited from StoringActor.getEntity
- Defined in backend/src/actors/StoringActor.ts:90

`Protected`storeEntity

storeEntity(entity: Entity): Promise<Entity>
Parameters
- entity: Entity
Returns Promise<Entity>
Inherited from StoringActor.storeEntity
- Defined in backend/src/actors/StoringActor.ts:115

`Protected` `Abstract`updateIndices

updateIndices(
draft: { cache: Map<string & BRAND<"UID">, Entity> },
entity: Entity,
): void
Parameters
- draft: { cache: Map<string & BRAND<"UID">, Entity> }
- entity: Entity
Returns void
Inherited from StoringActor.updateIndices
- Defined in backend/src/actors/StoringActor.ts:84

Class SubscribableActor<Entity, Message, Result>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SubscribableActor<Entity, Message, Result>

Properties

Protected ReadonlycollectionName

Protected Readonlyconnector

Protected Abstractstate

Methods

ProtectedafterEntityRemovedFromCache

Parameters

Returns Promise<void>

ProtectedafterEntityWasCached

Parameters

Returns Promise<void>

afterStart

Returns Promise<void>

beforeShutdown

Returns Promise<void>

Protectedcleanup

Returns void

ProtecteddeleteEntity

Parameters

Returns Promise<Unit>

ProtecteddetermineRole

Parameters

Returns Promise< [ UserRole: AccessRole, UserID: string & BRAND<"UID">, IsTemporaryAccount: boolean, ],>

ProtectedgetEntity

Parameters

Returns Promise<MaybeBase<Entity>>

ProtectedstoreEntity

Parameters

Returns Promise<Entity>

Protected AbstractupdateIndices

Parameters

Returns void

Settings

On This Page

Class SubscribableActor<Entity, Message, Result>`Abstract`

`Protected` `Readonly`collectionName

`Protected` `Readonly`connector

`Protected` `Abstract`state

`Protected`afterEntityRemovedFromCache

`Protected`afterEntityWasCached

`Protected`cleanup

`Protected`deleteEntity

`Protected`determineRole

Returns Promise<
[
UserRole: AccessRole,
UserID: string & BRAND<"UID">,
IsTemporaryAccount: boolean,
],
>

`Protected`getEntity

`Protected`storeEntity

`Protected` `Abstract`updateIndices