IClusterClient Interface

Reference

Definition

Namespace:: Orleans

Assembly:: Orleans.dll

Assembly:: Orleans.Core.dll

Package:: Microsoft.Orleans.Core v1.5.10

Package:: Microsoft.Orleans.Core v2.4.5

Package:: Microsoft.Orleans.Core v3.6.5

Package:: Microsoft.Orleans.Core v7.2.5

Package:: Microsoft.Orleans.Core v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Client interface for interacting with an Orleans cluster.

public interface IClusterClient : IDisposable, Orleans.IGrainFactory

public interface IClusterClient : IAsyncDisposable, IDisposable, Orleans.IGrainFactory

public interface IClusterClient : Orleans.IGrainFactory

type IClusterClient = interface
    interface IDisposable
    interface IGrainFactory

type IClusterClient = interface
    interface IGrainFactory
    interface IAsyncDisposable
    interface IDisposable

type IClusterClient = interface
    interface IGrainFactory

Public Interface IClusterClient
Implements IDisposable, IGrainFactory

Public Interface IClusterClient
Implements IAsyncDisposable, IDisposable, IGrainFactory

Public Interface IClusterClient
Implements IGrainFactory

Implements: IGrainFactory IDisposable IAsyncDisposable

Properties

Configuration	Gets the client configuration.
IsInitialized	Gets a value indicating whether or not this client is initialized.
Logger	Provides logging facility for applications.
ServiceProvider	Gets the service provider used by this client.

Methods

Abort()	Aborts the client ungracefully.
AbortAsync()	Aborts the client ungracefully.
BindGrainReference(IAddressable)	Binds the provided grain reference to this instance. (Inherited from IGrainFactory)
Close()	Stops the client gracefully, disconnecting from the cluster.
Connect()	Starts the client and connects to the configured cluster.
Connect(Func<Exception,Task<Boolean>>)	Starts the client and connects to the configured cluster.
CreateObjectReference<TGrainObserverInterface>(IGrainObserver)	Creates a reference to the provided `obj`. (Inherited from IGrainFactory)
DeleteObjectReference<TGrainObserverInterface>(IGrainObserver)	Deletes the provided object reference. (Inherited from IGrainFactory)
GetGrain(GrainId)	Returns an untyped reference for the provided grain id. (Inherited from IGrainFactory)
GetGrain(GrainId, GrainInterfaceType)	Returns a reference for the provided grain id which implements the specified interface type. (Inherited from IGrainFactory)
GetGrain(Type, Guid)	Returns a reference to the grain which is the primary implementation of the provided interface type and has the provided primary key. (Inherited from IGrainFactory)
GetGrain(Type, Guid, String)	Returns a reference to the grain which is the primary implementation of the provided interface type and has the provided primary key. (Inherited from IGrainFactory)
GetGrain(Type, Int64)	Returns a reference to the grain which is the primary implementation of the provided interface type and has the provided primary key. (Inherited from IGrainFactory)
GetGrain(Type, Int64, String)	Returns a reference to the grain which is the primary implementation of the provided interface type and has the provided primary key. (Inherited from IGrainFactory)
GetGrain(Type, String)	Returns a reference to the grain which is the primary implementation of the provided interface type and has the provided primary key. (Inherited from IGrainFactory)
GetGrain<TGrainInterface>(GrainId)	Returns a reference to the specified grain which implements the specified interface. (Inherited from IGrainFactory)
GetGrain<TGrainInterface>(Guid, String)	Gets a reference to a grain. (Inherited from IGrainFactory)
GetGrain<TGrainInterface>(Guid, String, String)	Gets a reference to a grain. (Inherited from IGrainFactory)
GetGrain<TGrainInterface>(Int64, String)	Gets a reference to a grain. (Inherited from IGrainFactory)
GetGrain<TGrainInterface>(Int64, String, String)	Gets a reference to a grain. (Inherited from IGrainFactory)
GetGrain<TGrainInterface>(String, String)	Gets a reference to a grain. (Inherited from IGrainFactory)
GetGrain<TGrainInterface>(Type, Guid)	A GetGrain overload that returns the runtime type of the grain interface and returns the grain cast to TGrainInterface. The main use-case is when you want to get a grain whose type is unknown at compile time (e.g. generic type parameters). (Inherited from IGrainFactory)
GetGrain<TGrainInterface>(Type, Guid, String)	A GetGrain overload that returns the runtime type of the grain interface and returns the grain cast to TGrainInterface. The main use-case is when you want to get a grain whose type is unknown at compile time (e.g. generic type parameters). (Inherited from IGrainFactory)
GetGrain<TGrainInterface>(Type, Int64)	A GetGrain overload that returns the runtime type of the grain interface and returns the grain cast to TGrainInterface. The main use-case is when you want to get a grain whose type is unknown at compile time (e.g. generic type parameters). (Inherited from IGrainFactory)
GetGrain<TGrainInterface>(Type, Int64, String)	A GetGrain overload that returns the runtime type of the grain interface and returns the grain cast to TGrainInterface. The main use-case is when you want to get a grain whose type is unknown at compile time (e.g. generic type parameters). (Inherited from IGrainFactory)
GetGrain<TGrainInterface>(Type, String)	A GetGrain overload that returns the runtime type of the grain interface and returns the grain cast to TGrainInterface. The main use-case is when you want to get a grain whose type is unknown at compile time (e.g. generic type parameters). (Inherited from IGrainFactory)
GetStreamProvider(String)	Returns the IStreamProvider with the specified `name`.
GetStreamProviders()	Returns a collection of all configured IStreamProviders.

Extension Methods

Configuration(IClusterClient)	Gets the client configuration.
GetStreamProvider(IClusterClient, String)	Gets the stream provider with the specified `name`.
GetBroadcastChannelProvider(IClusterClient, String)	Get the named broadcast channel provided.
Logger(IClusterClient)	Provides logging facility for applications.
GetTransactionAttributionGrain(IGrainFactory, Guid, Nullable<TransactionOption>)

Applies to