Class HazelcastClient

Hierarchy

HazelcastClient

Index

Constructors

constructor

Methods

Constructors

constructor

new HazelcastClient(config?: ClientConfig): HazelcastClient

- Defined in HazelcastClient.ts:81
Parameters
- Optional config: ClientConfig
Returns HazelcastClient

Methods

addDistributedObjectListener

addDistributedObjectListener(distributedObjectListener: DistributedObjectListener): Promise<string>

- Defined in HazelcastClient.ts:351
Registers a distributed object listener to cluster.

Parameters
- distributedObjectListener: DistributedObjectListener
Returns Promise<string>

registration id of the listener.

getAtomicLong

getAtomicLong(name: string): Promise<IAtomicLong>

- Defined in HazelcastClient.ts:250
Returns the distributed atomic long instance with given name.

Parameters
- name: string
Returns Promise<IAtomicLong>

getClusterService

getClusterService(): ClusterService

- Defined in HazelcastClient.ts:318
Returns ClusterService

getConfig

getConfig(): ClientConfig

- Defined in HazelcastClient.ts:286
Return configuration that this instance started with. Returned configuration object should not be modified.

Returns ClientConfig

getConnectionManager

getConnectionManager(): ClientConnectionManager

- Defined in HazelcastClient.ts:302
Returns ClientConnectionManager

getDistributedObjects

getDistributedObjects(): Promise<DistributedObject[]>

- Defined in HazelcastClient.ts:152
Gives all known distributed objects in cluster.

Returns Promise<DistributedObject[]>

getErrorFactory

getErrorFactory(): ClientErrorFactory

- Defined in HazelcastClient.ts:368
Returns ClientErrorFactory

getFlakeIdGenerator

getFlakeIdGenerator(name: string): Promise<FlakeIdGenerator>

- Defined in HazelcastClient.ts:259
Returns the distributed flake ID generator instance with given name.

Parameters
- name: string
Returns Promise<FlakeIdGenerator>

getHeartbeat

getHeartbeat(): Heartbeat

- Defined in HazelcastClient.ts:322
Returns Heartbeat

getInvocationService

getInvocationService(): InvocationService

- Defined in HazelcastClient.ts:294
Returns InvocationService

getLifecycleService

getLifecycleService(): LifecycleService

- Defined in HazelcastClient.ts:326
Returns LifecycleService

getList

getList<E>(name: string): Promise<IList<E>>

- Defined in HazelcastClient.ts:205
Returns the distributed list instance with given name.

Type parameters
- E
Parameters
- name: string
Returns Promise<IList<E>>

getListenerService

getListenerService(): ListenerService

- Defined in HazelcastClient.ts:298
Returns ListenerService

getLocalEndpoint

getLocalEndpoint(): ClientInfo

- Defined in HazelcastClient.ts:144
Gathers information of this local client.

Returns ClientInfo

getLock

getLock(name: string): Promise<ILock>

- Defined in HazelcastClient.ts:187
Returns the distributed lock instance with given name.

Parameters
- name: string
Returns Promise<ILock>

getLockReferenceIdGenerator

getLockReferenceIdGenerator(): LockReferenceIdGenerator

- Defined in HazelcastClient.ts:364
Returns LockReferenceIdGenerator

getLoggingService

getLoggingService(): LoggingService

- Defined in HazelcastClient.ts:337
Returns LoggingService

getMap

getMap<K, V>(name: string): Promise<IMap<K, V>>

- Defined in HazelcastClient.ts:169
Returns the distributed map instance with given name.

Type parameters
- K
- V
Parameters
- name: string
Returns Promise<IMap<K, V>>

getMultiMap

getMultiMap<K, V>(name: string): Promise<MultiMap<K, V>>

- Defined in HazelcastClient.ts:214
Returns the distributed multi-map instance with given name.

Type parameters
- K
- V
Parameters
- name: string
Returns Promise<MultiMap<K, V>>

getName

getName(): string

- Defined in HazelcastClient.ts:136
Returns the name of this Hazelcast instance.

Returns string

name of this Hazelcast instance

getNearCacheManager

getNearCacheManager(): NearCacheManager

- Defined in HazelcastClient.ts:314
Returns NearCacheManager

getPNCounter

getPNCounter(name: string): Promise<PNCounter>

- Defined in HazelcastClient.ts:268
Returns the distributed PN Counter instance with given name.

Parameters
- name: string
Returns Promise<PNCounter>

getPartitionService

getPartitionService(): PartitionService

- Defined in HazelcastClient.ts:306
Returns PartitionService

getProxyManager

getProxyManager(): ProxyManager

- Defined in HazelcastClient.ts:310
Returns ProxyManager

getQueue

getQueue<E>(name: string): Promise<IQueue<E>>

- Defined in HazelcastClient.ts:196
Returns the distributed queue instance with given name.

Type parameters
- E
Parameters
- name: string
Returns Promise<IQueue<E>>

getReliableTopic

getReliableTopic<E>(name: string): Promise<ITopic<E>>

- Defined in HazelcastClient.ts:232
Returns a distributed reliable topic instance with the given name.

Type parameters
- E
Parameters
- name: string
Returns Promise<ITopic<E>>

getRepairingTask

getRepairingTask(): RepairingTask

- Defined in HazelcastClient.ts:330
Returns RepairingTask

getReplicatedMap

getReplicatedMap<K, V>(name: string): Promise<ReplicatedMap<K, V>>

- Defined in HazelcastClient.ts:241
Returns the distributed replicated-map instance with given name.

Type parameters
- K
- V
Parameters
- name: string
Returns Promise<ReplicatedMap<K, V>>

getRingbuffer

getRingbuffer<E>(name: string): Promise<Ringbuffer<E>>

- Defined in HazelcastClient.ts:223
Returns a distributed ringbuffer instance with the given name.

Type parameters
- E
Parameters
- name: string
Returns Promise<Ringbuffer<E>>

getSemaphore

getSemaphore(name: string): Promise<ISemaphore>

- Defined in HazelcastClient.ts:277
Returns the distributed semaphore instance with given name.

Parameters
- name: string
Returns Promise<ISemaphore>

getSerializationService

getSerializationService(): SerializationService

- Defined in HazelcastClient.ts:290
Returns SerializationService

getSet

getSet<E>(name: string): Promise<ISet<E>>

- Defined in HazelcastClient.ts:178
Returns the distributed set instance with given name.

Type parameters
- E
Parameters
- name: string
Returns Promise<ISet<E>>

removeDistributedObjectListener

removeDistributedObjectListener(listenerId: string): Promise<boolean>

- Defined in HazelcastClient.ts:360
Removes a distributed object listener from cluster.

Parameters
- listenerId: string
  
  id of the listener to be removed.
Returns Promise<boolean>

true if registration is removed, false otherwise.

shutdown

shutdown(): void

- Defined in HazelcastClient.ts:375
Shuts down this client instance.

Returns void

Static newHazelcastClient

newHazelcastClient(config?: ClientConfig): Promise<HazelcastClient>

- Defined in HazelcastClient.ts:118
Creates a new client object and automatically connects to cluster.

Parameters
- Optional config: ClientConfig
  
  Default ClientConfig is used when this parameter is absent.
Returns Promise<HazelcastClient>

a new client instance

Generated using TypeDoc