HazelcastClient Class

Hazelcast Client enables you to do all Hazelcast operations without being a member of the cluster.

Inheritance Hierarchy

SystemObject
Hazelcast.ClientHazelcastClient

Namespace: Hazelcast.Client
Assembly: Hazelcast.Net (in Hazelcast.Net.dll) Version: 3.12.2

Syntax

C++

Copy

public sealed class HazelcastClient : IHazelcastInstance

Public NotInheritable Class HazelcastClient
	Implements IHazelcastInstance

public ref class HazelcastClient sealed : IHazelcastInstance

[<SealedAttribute>]
type HazelcastClient =  
    class
        interface IHazelcastInstance
    end

The HazelcastClient type exposes the following members.

Methods

	Name	Description
	AddDistributedObjectListener	Adds a Distributed Object listener which will be notified when a new IDistributedObject will be created or destroyed.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetAllHazelcastClients	Gets all Hazelcast clients.
	GetAtomicLong	Creates cluster-wide atomic long.
	GetClientService	Returns the client service of this Hazelcast instance.
	GetCluster	Returns the ICluster that this Hazelcast instance is part of.
	GetCountDownLatch	Creates cluster-wide CountDownLatch.
	GetDistributedObjectT
	GetDistributedObjects	Returns all IDistributedObject 's such as; queue, map, set, list, topic, lock, multimap.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetIdGenerator	Creates cluster-wide unique IDs.
	GetLifecycleService	Returns the lifecycle service for this instance.
	GetListT	Returns the distributed list instance with the specified name.
	GetLoadBalancer	Gets the configured ILoadBalancer instance
	GetLocalEndpoint	Returns the local Endpoint which this IHazelcastInstance is belongs to.
	GetLock	Returns the distributed lock instance for the specified key object.
	GetMapTKey, TValue	Returns the distributed map instance with the specified name.
	GetMultiMapTKey, TValue	Returns the distributed multimap instance with the specified name.
	GetName	Returns the name of this Hazelcast instance
	GetPartitionService	Not supported yet.
	GetPNCounter	PN (Positive-Negative) CRDT counter.
	GetQueueT	Returns the distributed queue instance with the specified name.
	GetReplicatedMapTKey, TValue	Returns the replicated map instance with the specified name.
	GetRingbufferT	Returns the distributed Ringbuffer instance with the specified name.
	GetSemaphore	Creates cluster-wide semaphore.
	GetSetT	Returns the distributed set instance with the specified name.
	GetTopicT	Returns the distributed topic instance with the specified name.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUserContext	Returns a ConcurrentMap that can be used to add user-context to the IHazelcastInstance.
	NewHazelcastClient	Creates a new hazelcast client using default configuration.
	NewHazelcastClient(String)	Creates a new hazelcast client using the given configuration xml file
	NewHazelcastClient(ClientConfig)	Creates a new hazelcast client using the given configuration object created programmaticly.
	NewTransactionContext	Creates a new ITransactionContext associated with the current thread using default options.
	NewTransactionContext(TransactionOptions)	Creates a new ITransactionContext associated with the current thread with given options.
	RemoveDistributedObjectListener	Removes the specified Distributed Object listener.
	Shutdown	Shuts down this IHazelcastInstance.
	ShutdownAll	Shutdowns all Hazelcast Clients .
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	PropPartitioningStrategyClass

Top

Remarks

Hazelcast Client enables you to do all Hazelcast operations without being a member of the cluster. It connects to one of the cluster members and delegates all cluster wide operations to it. When the connected cluster member dies, client will automatically switch to another live member.

Reference

Hazelcast.Client Namespace