Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • ClientConfig

Index

Properties

backupAckToClientEnabled?: boolean

Enables the 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.

clientLabels?: string[]

Labels for the client to be sent to the cluster.

clusterName?: string

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

connectionStrategy?: ConnectionStrategyConfig

Connection strategy config of the client.

customCredentials?: any

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

deprecated

Since version 5.1. Use security element instead.

customLogger?: ILogger

Custom logger implementation for the client.

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

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.

lifecycleListeners?: ((state: LifecycleState) => void)[]

Lifecycle listeners to be attached to the client.

loadBalancer?: LoadBalancerConfig

Load balancer config for the client.

membershipListeners?: MembershipListener[]

Membership listeners to be attached to the client.

metrics?: MetricsConfig

Metrics config. Using this config, you can enable client metrics collection and change the frequency of sending client metrics to the cluster. You can monitor clients using Hazelcast Management Center once the metrics collection is enabled.

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

Network config of the client.

properties?: Properties

User-defined properties.

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

security?: SecurityConfig

Contains configuration for the client to use different kinds of credential types during authentication, such as username/password, token, or custom credentials.

serialization?: SerializationConfig

User-defined serialization config for the client.

Generated using TypeDoc