ClientMessagingOptions Class

Definition

Namespace:

Orleans.Configuration

Assembly:

Orleans.Core.dll

Package:

Microsoft.Orleans.Core v8.2.0

Specifies global messaging options that are client related.

public class ClientMessagingOptions : Orleans.Configuration.MessagingOptions

type ClientMessagingOptions = class
    inherit MessagingOptions

Public Class ClientMessagingOptions
Inherits MessagingOptions

Inheritance

Object

MessagingOptions

ClientMessagingOptions

Constructors

ClientMessagingOptions()

Fields

DEFAULT_BUFFER_POOL_BUFFER_SIZE	(Inherited from MessagingOptions)
DEFAULT_BUFFER_POOL_MAX_SIZE	(Inherited from MessagingOptions)
DEFAULT_BUFFER_POOL_PREALLOCATION_SIZE	(Inherited from MessagingOptions)
DEFAULT_CLIENT_SENDER_BUCKETS	The default value for ClientSenderBuckets.
DEFAULT_DROP_EXPIRED_MESSAGES	(Inherited from MessagingOptions)
DEFAULT_LARGE_MESSAGE_WARNING_THRESHOLD	(Inherited from MessagingOptions)
DEFAULT_MAX_MESSAGE_BODY_SIZE	(Inherited from MessagingOptions)
DEFAULT_MAX_MESSAGE_HEADER_SIZE	(Inherited from MessagingOptions)
DEFAULT_PREFERRED_FAMILY	The default value for PreferredFamily.
DEFAULT_PROPAGATE_E2E_ACTIVITY_ID	(Inherited from MessagingOptions)

Properties

BufferPoolBufferSize	The size of a buffer in the messaging buffer pool. (Inherited from MessagingOptions)
BufferPoolMaxSize	The maximum size of the messaging buffer pool. (Inherited from MessagingOptions)
BufferPoolPreallocationSize	The initial size of the messaging buffer pool that is pre-allocated. (Inherited from MessagingOptions)
ClientSenderBuckets	Gets or sets the total number of grain buckets used by the client in client-to-gateway communication protocol. In this protocol, grains are mapped to buckets and buckets are mapped to gateway connections, in order to enable stickiness of grain to gateway (messages to the same grain go to the same gateway, while evenly spreading grains across gateways). This number should be about 10 to 100 times larger than the expected number of gateway connections. If this attribute is not specified, then Math.Pow(2, 13) is used.
DropExpiredMessages	Gets or sets a value indicating whether messages should be dropped once they expire, that is if it was not delivered to the destination before it has timed out on the sender. (Inherited from MessagingOptions)
LargeMessageWarningThreshold	The LargeMessageWarningThreshold attribute specifies when to generate a warning trace message for large messages. (Inherited from MessagingOptions)
LocalAddress	Gets or sets the IP address used for cluster client.
MaxMessageBodySize	The maximum size, in bytes, of the body for a message. The runtime will forcibly close the connection if the body size is greater than this value. (Inherited from MessagingOptions)
MaxMessageHeaderSize	The maximum size, in bytes, of the header for a message. The runtime will forcibly close the connection if the header size is greater than this value. (Inherited from MessagingOptions)
MaxResendCount	The MaxResendCount attribute specifies the maximal number of resends of the same message. (Inherited from MessagingOptions)
NetworkInterfaceName	Gets or sets the name of the network interface to use to work out an IP address for this machine.
PreferredFamily	Gets or sets the preferred AddressFamily to be used when determining an appropriate client identity.
PropagateActivityId	Whether Trace.CorrelationManager.ActivityId settings should be propagated into grain calls. (Inherited from MessagingOptions)
ResendOnTimeout	The ResendOnTimeout attribute specifies whether the message should be automatically resend by the runtime when it times out on the sender. Default is false. (Inherited from MessagingOptions)
ResponseTimeout	Gets or sets the default timeout before a request is assumed to have failed. (Inherited from MessagingOptions)
ResponseTimeoutWithDebugger	Gets or sets the effective ResponseTimeout value to use when a debugger is attached. (Inherited from MessagingOptions)