IHazelcastClient Interface

Namespace: Hazelcast

Assembly: Hazelcast.Net.dll

Represents the Hazelcast client.

The Hazelcast client is the entry point to all interactions with an Hazelcast cluster. A client is created by a HazelcastClientFactory. Before it can be used, it needs to be opened via the @Hazelcast.IHazelcastClient.OpenAsync* method. After it has been used, it needs to be disposed in order to properly release its resources. For example:

var options = new HazelcastOptionsBuilder.Build();
var client = await HazelcastClientFactory.StartNewClientAsync(options);
// ... use the client ...
await client.DisposeAsync();

public interface IHazelcastClient : IAsyncDisposable

Inherited Members

IAsyncDisposable.DisposeAsync()

Properties

Name	Description
CPSubsystem	Gets the CP subsystem.
ClusterName	Gets the name of the cluster.
Id	Gets the unique identifier of this client.
IsActive	Whether the client is active.
IsConnected	Whether the client is connected.
Members	Gets a snapshot of the members that the cluster declared to this client.
Name	Gets the name of this client.
Options	Gets the options that were used to configure this client.
Sql	Returns a service to execute distributed SQL queries.
State	Gets the client state.

Methods

Name	Description
BeginTransactionAsync()	Begins a new transaction.
BeginTransactionAsync(TransactionOptions)	Begins a new transaction.
DestroyAsync(IDistributedObject)	Destroys a distributed object.
GetDistributedObjectsAsync()	Gets information about all distributed objects known to the cluster.
GetFlakeIdGeneratorAsync(string)	Gets an IFlakeIdGenerator distributed object.
GetListAsync<T>(string)	Gets an IHList<T> distributed object.
GetMapAsync<TKey, TValue>(string)	Gets an IHMap<TKey, TValue> distributed object.
GetMultiMapAsync<TKey, TValue>(string)	Gets an IHMultiMap<TKey, TValue> distributed object.
GetQueueAsync<T>(string)	Gets an IHQueue<T> distributed object.
GetReplicatedMapAsync<TKey, TValue>(string)	Gets an IHReplicatedMap<TKey, TValue> distributed object.
GetRingBufferAsync<T>(string)	Gets an IHRingBuffer<TItem> distributed object.
GetSetAsync<T>(string)	Gets an IHSet<T> distributed object.
GetTopicAsync<T>(string)	Gets an IHTopic<T> distributed object.
SubscribeAsync(Action<HazelcastClientEventHandlers>)	Subscribes to events.
UnsubscribeAsync(Guid)	Unsubscribe from events.