EventSessionConfig Class Reference

List of all members.

---

Detailed Description

class EventSessionConfig Used for configuring an EventSession.

it contains a set of configuration parameters that influence the way event listeners are registered with the space
and how event notifications are processed.

To create an EventSessionConfig object:
1. use the empty constructor and set the different parameters using API
2. use a preconfigured, named set of parameters. the name is used to load a properties file
that resides in the config/schema directory

the names of the parameters that can be used in the properties object or file are:
comType - specifies the communication protocol: UNICAST / MULTIPLEX / MULTICAST
batchSize - the size of the batch used when sending notifications to the client.
must be used with batchTime
batchTime - the maximum elapsed time between two batch notifications.
must be used with batchSize
reliable - whether the notification process is reliable.
renew - whether to not to automatically renew the lease of the registered listeners.
durable - whether the events are durable.
replicateNotifyTemplate - whether to replicate the registration to other spaces in the cluster triggerNotifyTemplate - whether to send notifications from all spaces in the cluster.

Author:

Ezer Ben Simhon

See also:

IRemoteEventListener,EventSessionFactory,EventSessionConfig,DataEventSession,EventSession,EventRegistration,RemoteEvent

Public Member Functions
int	getBatchSize ()
	Returns: batchSize number of notifications in a batch.
long long	getBatchTime ()
	Returns: batchTime - the maximum elapsed time between two batch notifications.
int	getComType ()
	Gets the Communication type that is in use with this config.
long long	getRenewDuration ()
	Returns: the renew Duration.
long long	getRenewExpiration ()
	Returns: Returns the renewExpiration.
long long	getRenewRTT ()
	Returns: Returns the renewRTT.
bool	isAutoRenew ()
bool	isBatching ()
	Checks if using batch notifications.
bool	isFifo ()
	Checks if the order that is in use with this config is fifo.
bool	isReplicateNotifyTemplate ()
	Should this template be replicated.
bool	isTriggerNotifyTemplate ()
	Should notify template be triggered on replication event.
void	setBatch (int size, long long time)
	set the notifications to come in batches of size.
void	setComType (int comType)
	Set the Communication type to be used with this config.
void	setFifo (bool fifo)
	Set fifo order for the notifications.
void	setReplicateNotifyTemplate (bool replicateNotifyTemplate)
	Parameters: replicateNotifyTemplate
void	setTriggerNotifyTemplate (bool triggerNotifyTemplate)
	Parameters: triggerNotifyTemplate
Static Public Member Functions
static EventSessionConfigPtr	CreateSessionConfig (SpaceProxyPtr space, const char *schemaName=NULL)

---

Member Function Documentation

int EventSessionConfig::getBatchSize

(

)

Returns:

batchSize number of notifications in a batch.

long long EventSessionConfig::getBatchTime

(

)

Returns:

batchTime - the maximum elapsed time between two batch notifications.

int EventSessionConfig::getComType

(

)

Gets the Communication type that is in use with this config.

Returns:

the Communication type.

long long EventSessionConfig::getRenewDuration

(

)

Returns:

the renew Duration.

long long EventSessionConfig::getRenewExpiration

(

)

Returns:

Returns the renewExpiration.

long long EventSessionConfig::getRenewRTT

(

)

Returns:

Returns the renewRTT.

bool EventSessionConfig::isBatching

(

)

Checks if using batch notifications.

Returns:

true if notification comes in batches both size>0 and time>0 were set.

See also:

setBatch

bool EventSessionConfig::isFifo

(

)

Checks if the order that is in use with this config is fifo.

Returns:

true if notification comes in fifo order.

bool EventSessionConfig::isReplicateNotifyTemplate

(

)

Should this template be replicated.

Returns:

true if this template should be replicated. null is returned when this value was not set.

bool EventSessionConfig::isTriggerNotifyTemplate

(

)

Should notify template be triggered on replication event.

Returns:

true if trigger is needed on replication event. null is returned when this value was never set.

void EventSessionConfig::setBatch	(	int	size,
		long long	time
	)

set the notifications to come in batches of size.

notification can not be delay more then time ms.

Parameters:

	size	- amount of notification in batch.
	time	- maximum time to delay notification in not full batch.

void EventSessionConfig::setComType

(

int

comType

)

Set the Communication type to be used with this config.

Parameters:

comType

- ComType values: UNICAST, MULTIPLEX, MULTICAST.

void EventSessionConfig::setFifo

(

bool

fifo

)

Set fifo order for the notifications.

Parameters:

fifo

- true when using fifo order.

void EventSessionConfig::setReplicateNotifyTemplate

(

bool

replicateNotifyTemplate

)

Parameters:

replicateNotifyTemplate

void EventSessionConfig::setTriggerNotifyTemplate

(

bool

triggerNotifyTemplate

)

Parameters:

triggerNotifyTemplate

---