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.
Public Member Functions | ||||
int | getBatchSize () | |||
| ||||
long long | getBatchTime () | |||
| ||||
int | getComType () | |||
Gets the Communication type that is in use with this config. | ||||
long long | getRenewDuration () | |||
| ||||
long long | getRenewExpiration () | |||
| ||||
long long | getRenewRTT () | |||
| ||||
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) | |||
| ||||
void | setTriggerNotifyTemplate (bool triggerNotifyTemplate) | |||
| ||||
Static Public Member Functions | ||||
static EventSessionConfigPtr | CreateSessionConfig (SpaceProxyPtr space, const char *schemaName=NULL) |
int EventSessionConfig::getBatchSize | ( | ) |
batchSize
number of notifications in a batch.
long long EventSessionConfig::getBatchTime | ( | ) |
batchTime
- the maximum elapsed time between two batch notifications.
int EventSessionConfig::getComType | ( | ) |
Gets the Communication type that is in use with this config.
long long EventSessionConfig::getRenewDuration | ( | ) |
long long EventSessionConfig::getRenewExpiration | ( | ) |
long long EventSessionConfig::getRenewRTT | ( | ) |
bool EventSessionConfig::isBatching | ( | ) |
Checks if using batch notifications.
true
if notification comes in batches both size>0 and time>0 were set. bool EventSessionConfig::isFifo | ( | ) |
Checks if the order that is in use with this config is fifo.
bool EventSessionConfig::isReplicateNotifyTemplate | ( | ) |
Should this template be replicated.
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.
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.
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.
comType | - ComType values: UNICAST, MULTIPLEX, MULTICAST. |
void EventSessionConfig::setFifo | ( | bool | fifo | ) |
Set fifo order for the notifications.
fifo | - true when using fifo order. |
void EventSessionConfig::setReplicateNotifyTemplate | ( | bool | replicateNotifyTemplate | ) |
replicateNotifyTemplate |
void EventSessionConfig::setTriggerNotifyTemplate | ( | bool | triggerNotifyTemplate | ) |
triggerNotifyTemplate |