tibasListenerDef_GetTimeScope()

Returns the time scope attribute for a specified listenerDef.

Declaration

tibas_status tibasListenerDef_GetTimeScope
(tibasListenerDef listenerDef,
tibas_timeScope*   timeScope)

Parameters

Parameter Description
listenerDef The listenerDef for which you want to return a time scope.
timeScope The time scope can be TIBAS_TIME_SCOPE_SNAPSHOT, TIBAS_TIME_SCOPE_NEW, TIBAS_TIME_SCOPE_NEW_EVENTS, or TIBAS_TIME_SCOPE_ALL.

Remarks

Use the tibasListenerDef_GetTimeScope() function to return the time scope attribute for a specified listenerDef.

The time scope value can be:

TIBAS_TIME_SCOPE_ALL
The listener starts with all the tuples currently in the space at creation time (which will be presented as an initial set of PUT events) and then is continuously updated according to changes in the space.
TIBAS_TIME_SCOPE_SNAPSHOT
The listener contains only PUT events corresponding to the tuples stored in the space at creation time.
TIBAS_TIME_SCOPE_NEW
The listener starts empty and is updated only with events related to new or updated tuples in the space.
TIBAS_TIME_SCOPE_NEW_EVENTS
The listener starts empty and is updated with all events that occur in the space after creation time.

See Also

tibasListenerDef_Create(), tibasListenerDef_SetTimeScope()