Go to the documentation of this file.
22 #ifndef MamaSubscriptionH__
23 #define MamaSubscriptionH__
37 #if defined (__cplusplus)
225 const void *platformInfo,
586 uint8_t *appDataType);
663 int *ignoreDefinitelyDuplicate,
664 int *ignorePossiblyDuplicate,
665 int *ignoreDefinitelyDelayed,
666 int *ignorePossiblyDelayed,
667 int *ignoreOutOfSequence);
735 int *receivedInitial);
769 int *requiresInitial);
838 const char** source);
893 const char **symbol);
911 const char **symbol);
1020 uint8_t appDataType);
1108 int ignoreDefinitelyDuplicate,
1109 int ignorePossiblyDuplicate,
1110 int ignoreDefinitelyDelayed,
1111 int ignorePossiblyDelayed,
1112 int ignoreOutOfSequence);
1171 int requiresInitial);
1192 long serviceLevelOpt);
1243 const char *symbol);
1326 const char *sourceName,
1388 #if defined (__cplusplus)
MAMAExpDLL mama_status mamaSubscription_setRetries(mamaSubscription subscription, int retries)
Set the number of retries when requesting recaps.
@ DQ_SCHEME_DELIVER_ALL
Definition: subscription.h:116
wombat_subscriptionDestroyCB onDestroy
Definition: subscription.h:271
MAMAExpDLL mama_status mamaSubscription_setRecoverGaps(mamaSubscription subscription, int doesRecover)
Whether a subscription should attempt to recover from sequence number gaps.
MAMAExpDLL mama_status mamaSubscription_getSubscSymbol(mamaSubscription subscription, const char **symbol)
Return the symbol as subscribed to (i.e., as mapped by the mapping function, if any,...
MAMAExpDLL mama_status mamaSubscription_muteCurrentTopic(mamaSubscription subscription)
Mute the current topic for wildcard subscriptions.
mamaSubscriptionState
The enumeration describes the state of the subsubscription at any time.
Definition: subscription.h:70
@ DQ_FT_DO_NOT_WAIT_FOR_RECAP
Definition: subscription.h:123
void(MAMACALLTYPE * wombat_subscriptionErrorCB)(mamaSubscription subscription, mama_status status, void *platformError, const char *subject, void *closure)
Invoked if an error occurs during prior to subscription creation or if the subscription receives a me...
Definition: subscription.h:169
MAMAExpDLL mama_status mamaSubscription_setSubscriptionType(mamaSubscription subscription, mamaSubscriptionType type)
Set the subscription type for the subscription being created.
MAMAExpDLL mama_status mamaSubscription_getQueue(mamaSubscription subscription, mamaQueue *queue)
Return the mamaQueue for this subscription.
MAMAExpDLL mama_status mamaSubscription_getRecoverGaps(mamaSubscription subscription, int *doesRecover)
Whether the specified subscription will attempt to recover from sequence number gaps.
@ MAMA_SUBSCRIPTION_REACTIVATING
Definition: subscription.h:110
MAMAExpDLL mama_status mamaSubscription_createBasicWildCard(mamaSubscription subscription, mamaTransport transport, mamaQueue queue, const mamaWildCardMsgCallbacks *callbacks, const char *source, const char *symbol, void *closure)
Crate and activate a wildcard subscription that may be actually activated later.
MAMAExpDLL mama_status mamaSubscription_getItemClosure(mamaSubscription subscription, void **closure)
Return the item closure for the current message for the subscription.
mama_status
Definition: status.h:37
wombat_subscriptionOnMsgCB onMsg
Definition: subscription.h:267
wombat_subscriptionQualityCB onQuality
Definition: subscription.h:268
@ MAMA_SUBSCRIPTION_ALLOCATED
Definition: subscription.h:76
MAMAExpDLL int mamaSubscription_isValid(mamaSubscription subscription)
Return whether the subscription is valid, note that this function has been deprecated,...
wombat_subscriptionWildCardOnMsgCB onMsg
Definition: subscription.h:282
MAMAExpDLL mama_status mamaSubscription_setDebugLevel(mamaSubscription subscription, MamaLogLevel level)
Set the debug level for this subscription.
@ MAMA_SUBSCRIPTION_ACTIVATING
Definition: subscription.h:84
MAMAExpDLL mama_status mamaSubscription_getServiceLevelOpt(mamaSubscription subscription, long *serviceLevel)
Get the service level options for the specified subscription.
MAMAExpDLL mama_status mamaSubscription_getReceivedInitial(mamaSubscription subscription, int *receivedInitial)
Returns a value of 1 or 0 indicating whether the subscription has received an initial.
MAMAExpDLL mama_status mamaSubscription_getClosure(mamaSubscription subscription, void **closure)
Return the closure.
MAMAExpDLL mama_status mamaSubscription_getPlatformError(mamaSubscription subsc, void **error)
Return the middleware-specific platform error.
struct mamaSubscriptionImpl_ * mamaSubscription
Definition: types.h:99
preInitialScheme
MAMA can cache messages which arrive prior to an initial value.
Definition: subscription.h:57
MAMAExpDLL int mamaSubscription_checkDebugLevel(mamaSubscription subscription, MamaLogLevel level)
Return whether the debug level for this subscription equals or exceeds some level.
struct mamaWildCardMsgCallbacks_ mamaWildCardMsgCallbacks
A convenience structure for passing the callbacks to wild card subscription factory methods.
A convenience structure for passing the callbacks to the subscription factory methods.
Definition: subscription.h:263
MAMAExpDLL mama_status mamaSubscription_getSubscriptionType(mamaSubscription subscription, mamaSubscriptionType *type)
Returns the underlying mamaSubscriptionType for the specified subscription.
@ MAMA_SUBSCRIPTION_DEALLOCATED
Definition: subscription.h:107
void(MAMACALLTYPE * wombat_subscriptionOnMsgCB)(mamaSubscription subscription, mamaMsg msg, void *closure, void *itemClosure)
Invoked when a message arrives.
Definition: subscription.h:198
MAMAExpDLL mama_status mamaSubscription_setServiceLevel(mamaSubscription subscription, mamaServiceLevel serviceLevel, long serviceLevelOpt)
Set the service level.
MAMAExpDLL mama_status mamaSubscription_getPreIntitialCacheSize(mamaSubscription subscription, int *result)
Return the initial value cache size.
@ DQ_FT_WAIT_FOR_RECAP
Definition: subscription.h:124
dqStartegyScheme
Definition: subscription.h:114
MAMAExpDLL mama_status mamaSubscription_getServiceLevel(mamaSubscription subscription, mamaServiceLevel *serviceLevel)
Get the service level for the specified subscription.
struct mamaSourceImpl_ * mamaSource
Definition: types.h:116
@ MAMA_SUBSCRIPTION_ACTIVATED
Definition: subscription.h:87
void(MAMACALLTYPE * wombat_subscriptionQualityCB)(mamaSubscription subscription, mamaQuality quality, const char *symbol, short cause, const void *platformInfo, void *closure)
Invoked to indicate a data quality event.
Definition: subscription.h:220
wombat_subscriptionCreateCB onCreate
Definition: subscription.h:280
struct mamaMsgCallbacks_ mamaMsgCallbacks
A convenience structure for passing the callbacks to the subscription factory methods.
wombat_subscriptionDestroyCB onDestroy
Definition: subscription.h:283
MAMAExpDLL mama_status mamaSubscription_setupBasicWildCard(mamaSubscription subscription, mamaTransport transport, mamaQueue queue, const mamaWildCardMsgCallbacks *callbacks, const char *source, const char *symbol, void *closure)
Set the parameters for a wildcard subscription that may be actually activated later.
MAMAExpDLL mama_status mamaSubscription_getMsgQualifierFilter(mamaSubscription subscription, int *ignoreDefinitelyDuplicate, int *ignorePossiblyDuplicate, int *ignoreDefinitelyDelayed, int *ignorePossiblyDelayed, int *ignoreOutOfSequence)
Get the filters that discard message according to the message qualifier.
enum mamaServiceLevel_ mamaServiceLevel
mamaServiceLevel is an enumeration that represents the service level (a) requested by a subscribing a...
@ MAMA_SUBSCRIPTION_DEACTIVATING
Definition: subscription.h:90
MAMAExpDLL mama_status mamaSubscription_getTransport(mamaSubscription subscription, mamaTransport *transport)
Return the mamaTransport for this subscription.
MAMAExpDLL mama_status mamaSubscription_activate(mamaSubscription subscription)
Activate a subscription that has been set up by mamaSubscription_setup().
MAMAExpDLL mama_status mamaSubscription_getAppDataType(mamaSubscription subscription, uint8_t *appDataType)
Retrieve the application-specific data type.
MAMAExpDLL mama_status mamaSubscription_create(mamaSubscription subscription, mamaQueue queue, const mamaMsgCallbacks *callbacks, mamaSource source, const char *symbol, void *closure)
Create and activate subscription.
MAMAExpDLL mamaMsgCallbacks * mamaSubscription_getUserCallbacks(mamaSubscription subscription)
Returns a pointer to the mamaMsgCallbacks structure.
MAMAExpDLL mama_status mamaSubscription_setItemClosure(mamaSubscription subscription, void *closure)
Set the item closure for group subscriptions.
MAMAExpDLL mama_status mamaSubscription_deallocate(mamaSubscription subscription)
Free the memory for a mamaSubscription which was allocated via a call to mamaSubscription_allocate() ...
void(MAMACALLTYPE * wombat_subscriptionGapCB)(mamaSubscription subscription, void *closure)
Function invoked when a sequence number gap is detected.
Definition: subscription.h:185
MAMAExpDLL mama_status mamaSubscription_destroy(mamaSubscription subscription)
Destroy the subscription.
wombat_subscriptionGapCB onGap
Definition: subscription.h:269
MAMAExpDLL mama_status mamaSubscription_getRetries(mamaSubscription subscription, int *retries)
Retrieve the retries.
MAMAExpDLL mama_status mamaSubscription_deactivate(mamaSubscription subscription)
Deactivate a subscription.
struct mamaTransportImpl_ * mamaTransport
Definition: types.h:98
const MAMAExpDLL char * mamaSubscription_stringForState(mamaSubscriptionState state)
This function will return the string representation of the subscription state.
void(MAMACALLTYPE * wombat_subscriptionCreateCB)(mamaSubscription subscription, void *closure)
Function invoked when subscription creation is complete, and before any calls to wombat_subscriptionO...
Definition: subscription.h:137
MAMAExpDLL mama_status mamaSubscription_getSource(mamaSubscription subscription, const char **source)
Return the source for the specified subscription.
void(MAMACALLTYPE * wombat_subscriptionWildCardOnMsgCB)(mamaSubscription subscription, mamaMsg msg, const char *topic, void *closure, void *itemClosure)
Invoked when a message arrives for a wild card subscrption.
Definition: subscription.h:248
MAMAExpDLL mama_status mamaSubscription_setMsgQualifierFilter(mamaSubscription subscription, int ignoreDefinitelyDuplicate, int ignorePossiblyDuplicate, int ignoreDefinitelyDelayed, int ignorePossiblyDelayed, int ignoreOutOfSequence)
Set a filter to discard messages.
A convenience structure for passing the callbacks to wild card subscription factory methods.
Definition: subscription.h:278
@ DQ_SCHEME_INGORE_DUPS
Definition: subscription.h:117
MAMAExpDLL mama_status mamaSubscription_setPreIntitialCacheSize(mamaSubscription subscription, int cacheSize)
Set the number of messages to cache for each symbol before the initial value arrives.
MAMAExpDLL MamaLogLevel mamaSubscription_getDebugLevel(mamaSubscription subscription)
Return the debug level for this subscription.
MAMAExpDLL mama_status mamaSubscription_createBasic(mamaSubscription subscription, mamaTransport transport, mamaQueue queue, const mamaMsgCallbacks *callbacks, const char *symbol, void *closure)
Create a basic subscription without marketdata semantics.
MAMAExpDLL mama_status mamaSubscription_createSnapshot(mamaSubscription subscription, mamaQueue queue, const mamaMsgCallbacks *callbacks, mamaSource source, const char *symbol, void *closure)
Create a snapshot subscription for initial value only (no updates).
wombat_subscriptionErrorCB onError
Definition: subscription.h:281
MamaLogLevel
The level of detail when logging is enabled within the API.
Definition: log.h:36
@ PRE_INITIAL_SCHEME_ON_INITIAL
Definition: subscription.h:60
MAMAExpDLL mama_status mamaSubscription_setup2(mamaSubscription subscription, mamaTransport transport, mamaQueue queue, const mamaMsgCallbacks *callbacks, const char *sourceName, const char *symbol, void *closure)
Set the parameters for a subscription that may be actually activated later.
MAMAExpDLL mama_status mamaSubscription_setSymbol(mamaSubscription subscription, const char *symbol)
Set the symbol (e.g.
@ MAMA_SUBSCRIPTION_DESTROYED
Definition: subscription.h:99
struct mamaMsgImpl_ * mamaMsg
Opaque definitions for all major MAMA data types.
Definition: types.h:95
MAMAExpDLL mama_status mamaSubscription_setRequiresInitial(mamaSubscription subscription, int requiresInitial)
Whether an initial value is required for the specified subscription.
MAMAExpDLL mama_status mamaSubscription_getSymbol(mamaSubscription subscription, const char **symbol)
Return the symbol as provided by the user (before any symbol mapping).
@ PRE_INITIAL_SCHEME_ON_GAP
Definition: subscription.h:59
enum mamaQuality_ mamaQuality
MAMAExpDLL mama_status mamaSubscription_setTimeout(mamaSubscription subscription, double timeout)
Set the timeout for this subscription.
void(MAMACALLTYPE * wombat_subscriptionRecapCB)(mamaSubscription subscription, void *closure)
Function invoked when a recap is requested upon detecting a sequence number gap.
Definition: subscription.h:235
void(MAMACALLTYPE * wombat_subscriptionDestroyCB)(mamaSubscription subscription, void *closure)
Function invoked when a subscription has been completely destroyed, the client can have confidence th...
Definition: subscription.h:149
MAMAExpDLL mama_status mamaSubscription_getRequiresInitial(mamaSubscription subscription, int *requiresInitial)
Returns a value of 1 or 0 indicating whether this subscription is interested in initial values.
wombat_subscriptionRecapCB onRecapRequest
Definition: subscription.h:270
MAMAExpDLL mama_status mamaSubscription_destroyEx(mamaSubscription subscription)
This function will destroy the subscription and can be called from any thread.
MAMAExpDLL mama_status mamaSubscription_setGroupSizeHint(mamaSubscription subscription, int groupSizeHint)
A hint as to the expected size of size of groups when making group subscriptions.
MAMAExpDLL mama_status mamaSubscription_getState(mamaSubscription subscription, mamaSubscriptionState *state)
This function will return the current state of the subscription, this function should be used in pref...
@ MAMA_SUBSCRIPTION_UNKNOWN
Definition: subscription.h:73
@ MAMA_SUBSCRIPTION_DEACTIVATED
Definition: subscription.h:93
@ MAMA_SUBSCRIPTION_DEALLOCATING
Definition: subscription.h:102
dqftStrategyScheme
Definition: subscription.h:121
MAMAExpDLL mama_status mamaSubscription_getTimeout(mamaSubscription subscription, double *timeout)
Retrieve the timeout.
MAMAExpDLL int mamaSubscription_isActive(mamaSubscription subscription)
Returns whether the subscription is active, note that this function has been deprecated,...
MAMAExpDLL mama_status mamaSubscription_setup(mamaSubscription subscription, mamaQueue queue, const mamaMsgCallbacks *callbacks, mamaSource source, const char *symbol, void *closure)
Set the parameters for a subscription that may be actually activated later.
@ MAMA_SUBSCRIPTION_DESTROYING
Definition: subscription.h:96
@ MAMA_SUBSCRIPTION_SETUP
Definition: subscription.h:81
MAMAExpDLL mama_status mamaSubscription_setAppDataType(mamaSubscription subscription, uint8_t appDataType)
Set the application-specific data type.
wombat_subscriptionCreateCB onCreate
Definition: subscription.h:265
wombat_subscriptionErrorCB onError
Definition: subscription.h:266
struct mamaQueueImpl_ * mamaQueue
Definition: types.h:107
mamaSubscriptionType
Definition: subscriptiontype.h:34
MAMAExpDLL mama_status mamaSubscription_allocate(mamaSubscription *result)
Allocate memory for a new subscription.