GigaSpaces XAP.NET Documentation
EventSessionConfig Class
Class Library ► GigaSpaces.Core.Events ► EventSessionConfig
Encapsulates the variuos settings which can be used to configure an event session.
CopyC#
//Define an event session with auto renew.
EventSessionConfig sessionConfig = new EventSessionConfig();
sessionConfig.AutoRenew = true;
sessionConfig.AutoRenewTotalDuration = 60 * 60 * 1000;
sessionConfig.AutoRenewLeaseDuration= 10000;
sessionConfig.AutoRenewRTT = 1000;
sessionConfig.AutoRenewFailed += delegate {//_my failed notification handler code_//};
//Creates a data event session with the created config
IDataEventSession eventSession = mySpaceProxy.CreateDataEventSession(sessionConfig);
Declaration Syntax
C#Visual BasicVisual C++J#
public class EventSessionConfig
Public Class EventSessionConfig
public ref class EventSessionConfig
public class EventSessionConfig
Members
All MembersConstructorsMethodsPropertiesFieldsEvents



IconMemberDescription
EventSessionConfig()()()
Create an empty default configuration instance.

EventSessionConfig(EventSessionConfig)
Creates a copy of the specified configuration.

AutoRenew
Gets or sets whether the event session automatic lease renewal is enabled.
Note:If defined, AutoRenewFailed must have at least one subscriber.

AutoRenewFailed
Raised when an event session fails to renew a lease.

AutoRenewLeaseDuration Obsolete.
Gets or sets the lease period, in milliseconds, used to auto renew the Event Session. This period defines the max time passes between session failure, and the time the failure notifications is received. The parameter value must be bigger than AutoRenewRTT.

AutoRenewLeaseDurationDefaultValue
Default value for AutoRenewLeaseDuration property.

AutoRenewRTT Obsolete.
Gets or sets the time that takes to reach the server and return (Round trip time) in milliseconds. This value will be the time the renew request will be sent to the server prior to the end of the current lease.

AutoRenewRTTDefaultValue
Default value for AutoRenewRTT property.

AutoRenewTotalDuration Obsolete.
Gets or sets the total period of time, in milliseconds, at which Event Session lease will be auto renewed. Each renewal period will be of AutoRenewLeaseDuration.

AutoRenewTotalDurationDefaultValue
Default value for AutoRenewTotalDuration property.

Batch
Gets or sets whether Batch Notifications are enabled.
Note:If defined, BatchSize and BatchTime must be defined as well.

BatchPendingThreshold
Gets or sets the number of notifications accumulated at the server before notifications are sent to the client. If not set, is used.

BatchSize
Gets or sets the size of the batch used when sending notifications to the client.

BatchTime
Gets or sets the maximum elapsed time, in milliseconds, between two batch notifications.

ComType Obsolete.
Gets or sets the communication protocol.

ComTypeDefaultValue Obsolete.
Default value for ComType property.

DurableNotifications
Gets or sets whether to generate notifications that will not be lost during failover and disconnection.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Fifo
Gets or sets whether events should arrive in the order they are triggered.

FifoDefaultValue
Default value for Fifo property.

Finalize()()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()
Gets the Type of the current instance.
(Inherited from Object.)
GuaranteedNotifications Obsolete.
Gets or sets whether to generate notifications that will not be lost during failover.

MemberwiseClone()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
ReplicateNotifyTemplate
Gets or sets whether to replicate the registration to other spaces in the cluster the belongs to the same replication group.

ToString()()()
Returns a String that represents the current Object.
(Inherited from Object.)
TriggerNotifyTemplate
Gets or sets whether to send notifications from all spaces in the cluster that belongs the same replication group that were triggered by the same template.

Validate()()()
Validates the configuration to ensure that dependent properties are configured correctly.

Inheritance Hierarchy
Object
EventSessionConfig

Assembly: GigaSpaces.Core (Module: GigaSpaces.Core) Version: 10.1.0.0 (10.1.1.12800)