awNewTxSubscription
BrokerError awNewTxSubscription(
BrokerTxClient txclient,
char *event_type_name,
char *filter);
txclient | The Broker client requesting the subscription. |
event_type_name | The event type name for the subscription. |
filter | The event filter. Set to NULL if event filtering is not desired. |
Subscribes the specified txclient to events of the specified event type that match the filter string. If filter is NULL, all events of the specified event type will be considered to match the subscription.
An asterisk can be added to the end of an event type name as a wildcard if you want to open a subscription for multiple event types.
Note:
When using wildcards in the event_type_name, the filter may contain envelope fields but it may not contain any data fields. Wildcards cannot be used with the Broker::Trace or Broker::Activity event types.
If the subscription has already been registered, calling this function will have no effect.
This function implicitly passes a
subId field of zero; see
awNewSubscriptionWithId.
Possible BrokerError major codes | Meaning |
AW_ERROR_INVALID_CLIENT | The txclient has been destroyed or disconnected. |
AW_ERROR_INVALID_SUBSCRIPTION | The filter string contains a parse error. |
AW_ERROR_NO_PERMISSION | The txclient does not have permission to subscribe to the event type. |
AW_ERROR_NULL_PARAM | The event_type_name is NULL. |
AW_ERROR_UNKNOWN_EVENT_TYPE | The event type does not exist on the Broker. |
See also: