Class HazelcastClient

Hazelcast client instance. When you want to use Hazelcast's distributed data structures, you must first create a client instance. Multiple instances can be created on a single Node.js process.

Client instances should be shut down explicitly.

Hierarchy

HazelcastClient

Methods

addDistributedObjectListener

addDistributedObjectListener(listener: DistributedObjectListener): Promise<string>
Registers a distributed object listener to cluster.

Returns
registration id of the listener.
Parameters
- listener: DistributedObjectListener
  
  distributed object listener function. This will be called with DistributedObjectEvent.
Returns Promise<string>
- Defined in src/HazelcastClient.ts:525

getCPSubsystem

getCPSubsystem(): CPSubsystem
Returns the CP subsystem that offers a set of in-memory linearizable data structures.

Returns CPSubsystem
- Defined in src/HazelcastClient.ts:430

getCluster

getCluster(): Cluster
Returns the Cluster to which this client is connected.

Returns Cluster
- Defined in src/HazelcastClient.ts:445

getConfig

getConfig(): ClientConfig
Returns configuration that this instance started with. The returned object should not be modified.

Returns ClientConfig
- Defined in src/HazelcastClient.ts:438

getDistributedObjects

getDistributedObjects(): Promise<DistributedObject[]>
Returns all DistributedObjects, that is all maps, queues, topics, locks etc.

The results are returned on a best-effort basis. The result might miss just-created objects and contain just-deleted objects. An existing object can also be missing from the list occasionally. One cluster member is queried to obtain the list.

Returns
the collection of all instances in the cluster

Returns Promise<DistributedObject[]>
- Defined in src/HazelcastClient.ts:321

getFlakeIdGenerator

getFlakeIdGenerator(name: string): Promise<FlakeIdGenerator>
Returns the distributed Flake ID Generator instance with given name.
Parameters
- name: string
Returns Promise<FlakeIdGenerator>
- Defined in src/HazelcastClient.ts:415

getLifecycleService

getLifecycleService(): LifecycleService
Returns the lifecycle service for this client.

Returns LifecycleService
- Defined in src/HazelcastClient.ts:452

getList

getList<E>(name: string): Promise<IList<E>>
Returns the distributed List instance with given name.
Type Parameters
- E
Parameters
- name: string
Returns Promise<IList<E>>
- Defined in src/HazelcastClient.ts:380

getLocalEndpoint

getLocalEndpoint(): ClientInfo
Gathers information of this local client.

Returns ClientInfo
- Defined in src/HazelcastClient.ts:300

getMap

getMap<K, V>(name: string): Promise<IMap<K, V>>
Returns the distributed Map instance with given name.
Type Parameters
- K
- V
Parameters
- name: string
Returns Promise<IMap<K, V>>
- Defined in src/HazelcastClient.ts:359

getMultiMap

getMultiMap<K, V>(name: string): Promise<MultiMap<K, V>>
Returns the distributed MultiMap instance with given name.
Type Parameters
- K
- V
Parameters
- name: string
Returns Promise<MultiMap<K, V>>
- Defined in src/HazelcastClient.ts:387

getName

getName(): string
Returns the name of this Hazelcast instance.

Returns string
- Defined in src/HazelcastClient.ts:293

getPNCounter

getPNCounter(name: string): Promise<PNCounter>
Returns the distributed PN Counter instance with given name.
Parameters
- name: string
Returns Promise<PNCounter>
- Defined in src/HazelcastClient.ts:422

getPartitionService

getPartitionService(): PartitionService
Returns the partition service of this client.

Returns PartitionService
- Defined in src/HazelcastClient.ts:459

getQueue

getQueue<E>(name: string): Promise<IQueue<E>>
Returns the distributed Queue instance with given name.
Type Parameters
- E
Parameters
- name: string
Returns Promise<IQueue<E>>
- Defined in src/HazelcastClient.ts:373

getReliableTopic

getReliableTopic<E>(name: string): Promise<ITopic<E>>
Returns a distributed Reliable Topic instance with the given name.
Type Parameters
- E
Parameters
- name: string
Returns Promise<ITopic<E>>
- Defined in src/HazelcastClient.ts:401

getReplicatedMap

getReplicatedMap<K, V>(name: string): Promise<ReplicatedMap<K, V>>
Returns the distributed Replicated Map instance with given name.
Type Parameters
- K
- V
Parameters
- name: string
Returns Promise<ReplicatedMap<K, V>>
- Defined in src/HazelcastClient.ts:408

getRingbuffer

getRingbuffer<E>(name: string): Promise<Ringbuffer<E>>
Returns a distributed Ringbuffer instance with the given name.
Type Parameters
- E
Parameters
- name: string
Returns Promise<Ringbuffer<E>>
- Defined in src/HazelcastClient.ts:394

getSet

getSet<E>(name: string): Promise<ISet<E>>
Returns the distributed Set instance with given name.
Type Parameters
- E
Parameters
- name: string
Returns Promise<ISet<E>>
- Defined in src/HazelcastClient.ts:366

getSql

getSql(): SqlService
Returns a service to execute distributed SQL queries.

Returns
SQL service

see SqlService

Returns SqlService
- Defined in src/HazelcastClient.ts:516

removeDistributedObjectListener

removeDistributedObjectListener(listenerId: string): Promise<boolean>
Removes a distributed object listener from the cluster.

Returns
true if registration was removed, false otherwise.
Parameters
- listenerId: string
  
  id of the listener to be removed.
Returns Promise<boolean>
- Defined in src/HazelcastClient.ts:534

shutdown

shutdown(): Promise<void>
Shuts down this client instance.

Returns
Shutdown promise. Multiple invocations will return the same promise.

Returns Promise<void>
- Defined in src/HazelcastClient.ts:548

`Static` newHazelcastClient

newHazelcastClient(config?: ClientConfig): Promise<HazelcastClient>
Creates a new client object and automatically connects to cluster.

Throws
InvalidConfigurationError before returning if config is not a valid configuration object.

Returns
a new client instance
Parameters
- Optional config: ClientConfig
  
  Client config. Default client config is used when this parameter is absent.
Returns Promise<HazelcastClient>
- Defined in src/HazelcastClient.ts:267

`Static` newHazelcastFailoverClient

newHazelcastFailoverClient(failoverConfig?: ClientFailoverConfig): Promise<HazelcastClient>
Creates a client with cluster switch capability. Client will try to connect to alternative clusters according to failover configuration when it disconnects from a cluster.

Returns
a new client instance

Throws
InvalidConfigurationError before returning if the provided failover configuration is not valid
Parameters
- Optional failoverConfig: ClientFailoverConfig
  
  Configuration object describing the failover client configs and try count
Returns Promise<HazelcastClient>
- Defined in src/HazelcastClient.ts:283

Class HazelcastClient

Hierarchy

Index

Methods

Methods

addDistributedObjectListener

Returns

Parameters

listener: DistributedObjectListener

Returns Promise<string>

getCPSubsystem

Returns CPSubsystem

getCluster

Returns Cluster

getConfig

Returns ClientConfig

getDistributedObjects

Returns

Returns Promise<DistributedObject[]>

getFlakeIdGenerator

Parameters

name: string

Returns Promise<FlakeIdGenerator>

getLifecycleService

Returns LifecycleService

getList

Type Parameters

E

Parameters

name: string

Returns Promise<IList<E>>

getLocalEndpoint

Returns ClientInfo

getMap

Type Parameters

K

V

Parameters

name: string

Returns Promise<IMap<K, V>>

getMultiMap

Type Parameters

K

V

Parameters

name: string

Returns Promise<MultiMap<K, V>>

getName

Returns string

getPNCounter

Parameters

name: string

Returns Promise<PNCounter>

getPartitionService

Returns PartitionService

getQueue

Type Parameters

E

Parameters

name: string

Returns Promise<IQueue<E>>

getReliableTopic

Type Parameters

E

Parameters

name: string

Returns Promise<ITopic<E>>

getReplicatedMap

Type Parameters

K

V

Parameters

name: string

Returns Promise<ReplicatedMap<K, V>>

getRingbuffer

Type Parameters

E

Parameters

name: string

Returns Promise<Ringbuffer<E>>

`Static` newHazelcastClient

`Optional` config: ClientConfig

`Static` newHazelcastFailoverClient

`Optional` failoverConfig: ClientFailoverConfig