Interface DistributedObject

Base interface for distributed objects.

Hierarchy

DistributedObject
- FencedLock
- FlakeIdGenerator
- IAtomicLong
- IAtomicReference
- ICountDownLatch
- IList
- IMap
- IQueue
- ISemaphore
- ISet
- ITopic
- MultiMap
- PNCounter
- ReplicatedMap
- Ringbuffer

Index

Methods

destroy getName getPartitionKey getServiceName

Methods

destroy

destroy(): Promise<void>
Destroys this object cluster-wide. Clears all resources taken for this object.

Returns Promise<void>
- Defined in src/core/DistributedObject.ts:43

getName

getName(): string
Returns the unique name of this object.

Returns string
- Defined in src/core/DistributedObject.ts:32

getPartitionKey

getPartitionKey(): string
Returns the key of the partition that this DistributedObject is assigned to. For a partitioned data structure, the returned value will not be null, but otherwise undefined.

Returns string
- Defined in src/core/DistributedObject.ts:27

getServiceName

getServiceName(): string
Returns the service name for this object.

Returns string
- Defined in src/core/DistributedObject.ts:37

Generated using TypeDoc