HazelcastClient | hazelcast-client

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>

- Defined in src/HazelcastClient.ts:525
Registers a distributed object listener to cluster.

Parameters
- listener: DistributedObjectListener
  
  distributed object listener function. This will be called with DistributedObjectEvent.
Returns Promise<string>
registration id of the listener.

getCPSubsystem

getCPSubsystem(): CPSubsystem

- Defined in src/HazelcastClient.ts:430
Returns the CP subsystem that offers a set of in-memory linearizable data structures.

Returns CPSubsystem

getCluster

getCluster(): Cluster

- Defined in src/HazelcastClient.ts:445
Returns the Cluster to which this client is connected.

Returns Cluster

getConfig

getConfig(): ClientConfig

- Defined in src/HazelcastClient.ts:438
Returns configuration that this instance started with. The returned object should not be modified.

Returns ClientConfig

getDistributedObjects

getDistributedObjects(): Promise<DistributedObject[]>

- Defined in src/HazelcastClient.ts:321
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 Promise<DistributedObject[]>
the collection of all instances in the cluster

getFlakeIdGenerator

getFlakeIdGenerator(name: string): Promise<FlakeIdGenerator>

- Defined in src/HazelcastClient.ts:415
Returns the distributed Flake ID Generator instance with given name.

Parameters
- name: string
Returns Promise<FlakeIdGenerator>

getLifecycleService

getLifecycleService(): LifecycleService

- Defined in src/HazelcastClient.ts:452
Returns the lifecycle service for this client.

Returns LifecycleService

getList

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

- Defined in src/HazelcastClient.ts:380
Returns the distributed List instance with given name.

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

getLocalEndpoint

getLocalEndpoint(): ClientInfo

- Defined in src/HazelcastClient.ts:300
Gathers information of this local client.

Returns ClientInfo

getMap

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

- Defined in src/HazelcastClient.ts:359
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 src/HazelcastClient.ts:387
Returns the distributed MultiMap instance with given name.

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

getName

getName(): string

- Defined in src/HazelcastClient.ts:293
Returns the name of this Hazelcast instance.

Returns string

getPNCounter

getPNCounter(name: string): Promise<PNCounter>

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

Parameters
- name: string
Returns Promise<PNCounter>

getPartitionService

getPartitionService(): PartitionService

- Defined in src/HazelcastClient.ts:459
Returns the partition service of this client.

Returns PartitionService

getQueue

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

- Defined in src/HazelcastClient.ts:373
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 src/HazelcastClient.ts:401
Returns a distributed Reliable Topic instance with the given name.

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

getReplicatedMap

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

- Defined in src/HazelcastClient.ts:408
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 src/HazelcastClient.ts:394
Returns a distributed Ringbuffer instance with the given name.

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

getSet

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

- Defined in src/HazelcastClient.ts:366
Returns the distributed Set instance with given name.

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

getSql

getSql(): SqlService

- Defined in src/HazelcastClient.ts:516
Returns a service to execute distributed SQL queries.

Returns SqlService
SQL service

see SqlService

removeDistributedObjectListener

removeDistributedObjectListener(listenerId: string): Promise<boolean>

- Defined in src/HazelcastClient.ts:534
Removes a distributed object listener from the cluster.

Parameters
- listenerId: string
  
  id of the listener to be removed.
Returns Promise<boolean>
true if registration was removed, false otherwise.

shutdown

shutdown(): Promise<void>

- Defined in src/HazelcastClient.ts:548
Shuts down this client instance.

Returns Promise<void>
Shutdown promise. Multiple invocations will return the same promise.

Static newHazelcastClient

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

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

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

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

Static newHazelcastFailoverClient

newHazelcastFailoverClient(failoverConfig?: ClientFailoverConfig): Promise<HazelcastClient>

- Defined in src/HazelcastClient.ts:283
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.

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>
a new client instance

Hierarchy

Index

Methods

Methods

addDistributedObjectListener

Parameters

listener: DistributedObjectListener

Returns Promise<string>

getCPSubsystem

Returns CPSubsystem

getCluster

Returns Cluster

getConfig

Returns ClientConfig

getDistributedObjects

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>>

getSet

Type Parameters

E