Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClientConfig

Top level configuration object of Hazelcast client. Other configurations items are properties of this object.

Hierarchy

  • ClientConfig

Index

Properties

Optional backupAckToClientEnabled

backupAckToClientEnabled: boolean

Enables client to get backup acknowledgements directly from the member that backups are applied, which reduces number of hops and increases performance for smart clients.

Enabled by default for smart clients. This option has no effect for unisocket clients.

Optional clientLabels

clientLabels: string[]

Labels for the client to be sent to the cluster.

Optional clusterName

clusterName: string

Name of the cluster to connect to. By default, set to dev.

Optional connectionStrategy

connectionStrategy: ConnectionStrategyConfig

Connection strategy config of the client.

Optional customCredentials

customCredentials: any

Custom credentials to be used as a part of authentication on the cluster.

Optional customLogger

customLogger: ILogger

Custom logger implementation for the client.

Optional flakeIdGenerators

flakeIdGenerators: {}

Configs for Flake ID Generators.

Hazelcast client supports wildcard configuration for Flake ID Generators. Using an asterisk (*) character in the name, different instances of generators can be configured by a single configuration.

When you use default as the config key, it has a special meaning. Hazelcast client will use that configuration as the default one for all Flake ID Generators, unless there is a specific configuration for the generator.

Type declaration

Optional instanceName

instanceName: string

Name of the client instance. By default, set to hz.client_${CLIENT_ID}, where CLIENT_ID starts from 0 and it is incremented by 1 for each new client.

Optional lifecycleListeners

lifecycleListeners: Array<(state: LifecycleState) => void>

Lifecycle listeners to be attached to the client.

Optional loadBalancer

loadBalancer: LoadBalancerConfig

Load balancer config for the client.

Optional membershipListeners

membershipListeners: MembershipListener[]

Membership listeners to be attached to the client.

Optional nearCaches

nearCaches: {}

Near Cache config for the client.

Hazelcast client supports wildcard configuration for Near Caches. Using an asterisk (*) character in the name, different instances of Maps can be configured by a single configuration.

When you use default as the config key, it has a special meaning. Hazelcast client will use that configuration as the default one for all Maps, unless there is a specific configuration for the Map.

Type declaration

Optional network

Network config of the client.

Optional properties

properties: Properties

User-defined properties.

Optional reliableTopics

reliableTopics: {}

Configs for Reliable Topics.

Hazelcast client supports wildcard configuration for Reliable Topics. Using an asterisk (*) character in the name, different instances of topics can be configured by a single configuration.

When you use default as the config key, it has a special meaning. Hazelcast client will use that configuration as the default one for all Reliable Topics, unless there is a specific configuration for the topic.

Type declaration

Optional serialization

serialization: SerializationConfig

User-defined serialization config for the client.

Generated using TypeDoc