Edit

Share via


GrainClient Class

Definition

Caution

This type is obsolete and may be removed in a future release. Use ClientBuilder to create an instance of IClusterClient instead.

Client runtime for connecting to Orleans system

public static class GrainClient
[System.Obsolete("This type is obsolete and may be removed in a future release. Use ClientBuilder to create an instance of IClusterClient instead.")]
public static class GrainClient
type GrainClient = class
[<System.Obsolete("This type is obsolete and may be removed in a future release. Use ClientBuilder to create an instance of IClusterClient instead.")>]
type GrainClient = class
Public Class GrainClient
Inheritance
GrainClient
Attributes

Properties

ClientInvokeCallback

Global pre-call interceptor function Synchronous callback made just before a message is about to be constructed and sent by a client to a grain. This call will be made from the same thread that constructs the message to be sent, so any thread-local settings such as Orleans.RequestContext will be picked up. The action receives an InvokeMethodRequest with details of the method to be invoked, including InterfaceId and MethodId, and a IGrain which is the GrainReference this request is being sent through

ConfigureClientDelegate

delegate to add some configuration to the client

ConfigureLoggingDelegate

delegate to configure logging, default to none logger configured

GrainFactory
Instance
IsInitialized

Whether the client runtime has already been initialized

Logger

Provides logging facility for applications.

Methods

GetResponseTimeout()

Get a timeout of responses on this Orleans client.

GetStreamProvider(String)
GetStreamProviders()
HardKill()

Test hook to uninitialize client without cleanup

Initialize()

Initializes the client runtime from the standard client configuration file.

Initialize(ClientConfiguration)

Initializes the client runtime from the provided client configuration object. If the configuration object is null, the initialization fails.

Initialize(FileInfo)

Initializes the client runtime from the provided client configuration file. If an error occurs reading the specified configuration file, the initialization fails.

Initialize(IPEndPoint, Boolean)
Obsolete.

Initializes the client runtime from the standard client configuration file using the provided gateway address. Any gateway addresses specified in the config file will be ignored and the provided gateway address wil be used instead.

Initialize(String)

Initializes the client runtime from the provided client configuration file. If an error occurs reading the specified configuration file, the initialization fails.

SetResponseTimeout(TimeSpan)

Set a timeout for responses on this Orleans client.

Uninitialize()

Uninitializes client runtime.

Events

ClusterConnectionLost

Applies to