|
TIBCO FTL®
|
Asynchronous advisory messages carry information about the operation of FTL. Programs can receive this information through subscribers on the advisory endpoint. More...
Macros | |
| #define | TIB_ADVISORY_ENDPOINT_NAME "_advisoryEndpoint" |
| Name of the special endpoint that carries FTL advisory messages; string. More... | |
| #define | TIB_ADVISORY_FIELD_ADVISORY "_advisory" |
| A field with this field name distinguishes advisory messages. More... | |
| #define | TIB_ADVISORY_FIELD_AGGREGATION_COUNT "aggregation_count" |
| Aggregation incidents (field name). More... | |
| #define | TIB_ADVISORY_FIELD_AGGREGATION_TIME "aggregation_time" |
| Aggregation time interval (field name). More... | |
| #define | TIB_ADVISORY_FIELD_ENDPOINTS "endpoints" |
| Endpoints (field name). More... | |
| #define | TIB_ADVISORY_FIELD_LOCK_NAME "lock_name" |
| Lock Name (field name). More... | |
| #define | TIB_ADVISORY_FIELD_MODULE "module" |
| Module (field name). More... | |
| #define | TIB_ADVISORY_FIELD_NAME "name" |
| Advisory name (field name). More... | |
| #define | TIB_ADVISORY_FIELD_QUEUE_NAME "queue_name" |
| Queue name (field name). More... | |
| #define | TIB_ADVISORY_FIELD_REASON "reason" |
| Advisory reason (field name). More... | |
| #define | TIB_ADVISORY_FIELD_SEVERITY "severity" |
| Advisory severity (field name). More... | |
| #define | TIB_ADVISORY_FIELD_SUBSCRIBER_NAME "subscriber_name" |
| Subscriber name (field name). More... | |
| #define | TIB_ADVISORY_FIELD_TIMESTAMP "timestamp" |
| Timestamp (field name). More... | |
| #define | TIB_ADVISORY_MODULE_BASE "BASE" |
| The advisory message pertains to the FTL API base library implementation code (module). More... | |
| #define | TIB_ADVISORY_NAME_DATALOSS "DATALOSS" |
| The advisory message reports data loss. More... | |
| #define | TIB_ADVISORY_NAME_LOCK_LOST "LOCK_LOST" |
| The advisory message reports that a lock previously held by this application was stolen by some other application. More... | |
| #define | TIB_ADVISORY_NAME_RESOURCE_AVAILABLE "RESOURCE_AVAILABLE" |
| The advisory message reports that a resource is available. More... | |
| #define | TIB_ADVISORY_NAME_RESOURCE_UNAVAILABLE "RESOURCE_UNAVAILABLE" |
| The advisory message reports that a resource is unavailable. More... | |
| #define | TIB_ADVISORY_NAME_RETRANSMISSION "RETRANSMISSION" |
| The advisory message reports multicast retransmission. More... | |
| #define | TIB_ADVISORY_NAME_SUBSCRIBER_FORCE_CLOSE "SUBSCRIBER_FORCE_CLOSE" |
| The advisory message reports that a persistence store forced a durable subscriber to close. More... | |
| #define | TIB_ADVISORY_REASON_DIRECT_SUB_LOSS "DIRECT_SUBSCRIBER_LOSS" |
| The advisory reports data loss; the reason is direct subscriber detected data loss in the inbound stream. More... | |
| #define | TIB_ADVISORY_REASON_DURABLE_SUBSCRIBER_COLLISION "DURABLE_SUBSCRIBER_COLLISION" |
| The advisory reports that a persistence store forced a subscriber to close; the reason is durable subscriber collision. More... | |
| #define | TIB_ADVISORY_REASON_FAILOVER_LOSS "FAILOVER_LOSS" |
| The advisory reports potential data loss; the reason is failover to a backup forwarding component. More... | |
| #define | TIB_ADVISORY_REASON_INCOMPLETE_MESSAGE "INCOMPLETE_MESSAGE" |
| The advisory reports data loss; the reason is an incomplete message. More... | |
| #define | TIB_ADVISORY_REASON_LOCK_LOST_ON_DISCONNECT "LOCK_LOST_ON_DISCONNECT" |
| The advisory reports lock lost notification; the reason is a lock that was previously held by this application was lost because of a disconnect from the persistence store. More... | |
| #define | TIB_ADVISORY_REASON_LOCK_STOLEN "LOCK_STOLEN" |
| The advisory reports lock lost notification; the reason is a lock that was previously held by this application was stolen by some other application. More... | |
| #define | TIB_ADVISORY_REASON_PERSISTENCE_STORE_AVAILABLE "PERSISTENCE_STORE_AVAILABLE" |
| The advisory reports resource availability; the reason is that a persistence store is available. More... | |
| #define | TIB_ADVISORY_REASON_PERSISTENCE_STORE_AVAILABLE_AFTER_CLUSTER_DATALOSS "PERSISTENCE_STORE_AVAILABLE_AFTER_CLUSTER_DATALOSS" |
| The advisory reports resource availability; the reason is that a persistence store is available but the cluster lost some or all data. More... | |
| #define | TIB_ADVISORY_REASON_PERSISTENCE_STORE_UNAVAILABLE "PERSISTENCE_STORE_UNAVAILABLE" |
| The advisory reports resource unavailability; the reason is that a persistence store is not available. More... | |
| #define | TIB_ADVISORY_REASON_QUEUE_LIMIT_EXCEEDED "QUEUE_LIMIT_EXCEEDED" |
| The advisory message reports data loss; the reason is overflow of an event queue. More... | |
| #define | TIB_ADVISORY_REASON_RECONNECT_LOSS "RECONNECT_LOSS" |
| The advisory reports potential data loss; the reason is a temporary network disconnect between two connection-oriented transports (that is, TCP or RDMA). More... | |
| #define | TIB_ADVISORY_REASON_RETRANSMISSION_REQUEST "RETRANSMISSION_REQUEST" |
| The advisory reports that the subscribing endpoint of a multicast transport in the application requested retransmission from a publishing endpoint. More... | |
| #define | TIB_ADVISORY_REASON_RETRANSMISSION_REQUEST_SUPPRESSED "RETRANSMISSION_REQUEST_SUPPRESSED" |
| The advisory reports that the subscribing endpoint of a multicast transport in the application would have requested retransmission, but request was suppressed. More... | |
| #define | TIB_ADVISORY_REASON_RETRANSMISSION_SENT "RETRANSMISSION_SENT" |
| The advisory reports that the publishing endpoint of a multicast transport in the application has sent a retransmission as requested. More... | |
| #define | TIB_ADVISORY_REASON_SENDER_DISCARD "SENDER_DISCARD" |
| The advisory reports data loss; the reason is a sending transport has discarded data in accordance with its backlog settings. More... | |
| #define | TIB_ADVISORY_REASON_STORE_DISCARD_DATALOSS "STORE_DISCARD_DATALOSS" |
| The advisory reports data loss when a subscriber to a last-value durable has missed one or more messages from the persistence store. More... | |
| #define | TIB_ADVISORY_REASON_TPORT_DATALOSS "TPORT_DATALOSS" |
| The advisory reports data loss; the reason is a transport malfunction. More... | |
| #define | TIB_ADVISORY_REASON_UPSTREAM_LOSS "UPSTREAM_LOSS" |
| The advisory reports potential data loss; the reason is a data loss advisory detected upstream at a forwarding component (such as a transport bridge). More... | |
| #define | TIB_ADVISORY_SEVERITY_DEBUG "DEBUG" |
| The advisory message is for debugging (severity value). More... | |
| #define | TIB_ADVISORY_SEVERITY_INFO "INFO" |
| The advisory message is informational (severity value). More... | |
| #define | TIB_ADVISORY_SEVERITY_WARN "WARN" |
| The advisory message is a warning (severity value). More... | |
Asynchronous advisory messages carry information about the operation of FTL. Programs can receive this information through subscribers on the advisory endpoint.
This file defines constants related to advisory messages, their field names and field values.
For more information, see the chapter "Advisory Messages" in the book TIBCO FTL Development.
| #define TIB_ADVISORY_ENDPOINT_NAME "_advisoryEndpoint" |
Name of the special endpoint that carries FTL advisory messages; string.
To receive FTL advisory messages, create a subscriber on this endpoint name.
The realm object scopes the advisories that a subscriber on this endpoint can receive. That is, a subscriber to this endpoint receives only those advisories produced by other objects in the same program and the same realm (as the advisory subscriber).
It is illegal to create a publisher on this endpoint name.
| #define TIB_ADVISORY_FIELD_ADVISORY "_advisory" |
A field with this field name distinguishes advisory messages.
All advisory messages contain this field.
Only advisory messages may contain this field.
Use this field only for matching purposes. Your program code must never set this field in any message. This field always has the integer value 1.
| #define TIB_ADVISORY_FIELD_AGGREGATION_COUNT "aggregation_count" |
Aggregation incidents (field name).
Some advisory messages report aggregate data, representing several incidents that occurred within a time interval. The long integer value of the aggregation_count field indicates the number of incidents.
In DATALOSS advisories with reason QUEUE_LIMIT_EXCEEDED, this value reports the number of events that the queue discarded.
| #define TIB_ADVISORY_FIELD_AGGREGATION_TIME "aggregation_time" |
Aggregation time interval (field name).
Some advisory messages report aggregate data, representing several incidents that occurred within a time interval. The double floating point value (in seconds) of the aggregation_time field indicates the length of the time interval.
The time interval ends shortly before the timestamp on the advisory message.
| #define TIB_ADVISORY_FIELD_ENDPOINTS "endpoints" |
Endpoints (field name).
This field can appear in DATALOSS, SUBSCRIBER_FORCE_CLOSE, and RETRANSMISSION advisories.
In DATALOSS advisories, the string array value of the endpoints field lists the endpoints that could have lost data.
Although data loss occurs primarily in a transport, its symptoms could affect all endpoints that use the transport – and by extension, any subscriber on those endpoints. Furthermore, transport names are meaningful to administrators, but usually not available to programmers. This advisory field reports the set of all endpoints through which the program could access the problematic transport (according to the configuration in the local realm object).
This field does not appear in DATALOSS advisories with reason QUEUE_LIMIT_EXCEEDED.
In SUBSCRIBER_FORCE_CLOSE advisories, the string array value of the endpoints field identifies the endpoint of the closed subscriber object.
RETRANSMISSION advisories, the string array value of the endpoints field identifies the endpoint involved in the retransmission event. | #define TIB_ADVISORY_FIELD_LOCK_NAME "lock_name" |
Lock Name (field name).
This field can appear in LOCK_LOST advisories.
The string value of the lock_name field identifies the name of the lock that was stolen by some other application.
| #define TIB_ADVISORY_FIELD_MODULE "module" |
Module (field name).
The string value of the module field denotes the part of FTL to which the advisory pertains.
| #define TIB_ADVISORY_FIELD_NAME "name" |
Advisory name (field name).
The string value of the name field denotes the the main issue that the advisory reports.
| #define TIB_ADVISORY_FIELD_QUEUE_NAME "queue_name" |
Queue name (field name).
This field appears in DATALOSS advisories with reason QUEUE_LIMIT_EXCEEDED.
The string value of the queue_name field identifies the queue that discarded excess events.
If the queue's name property is not set, then the advisory message omits this field.
| #define TIB_ADVISORY_FIELD_REASON "reason" |
Advisory reason (field name).
The string value of the reason field provides additional information about the reason for the advisory (adding detail to the name field).
| #define TIB_ADVISORY_FIELD_SEVERITY "severity" |
Advisory severity (field name).
The string value of the severity field classifies each advisory according to the ability of FTL to fulfill its function as a message carrier.
| #define TIB_ADVISORY_FIELD_SUBSCRIBER_NAME "subscriber_name" |
Subscriber name (field name).
This field can appear in SUBSCRIBER_FORCE_CLOSE advisories.
The string value of the subscriber_name field identifies the closed durable subscriber.
| #define TIB_ADVISORY_FIELD_TIMESTAMP "timestamp" |
Timestamp (field name).
The tibDateTime value of the timestamp field indicates the time that FTL generated the advisory.
Although DateTime values can represent time with nanosecond precision, the actual resolution of the timestamp is only as fine-grained as the host computer's operating system supports.
| #define TIB_ADVISORY_MODULE_BASE "BASE" |
The advisory message pertains to the FTL API base library implementation code (module).
This string value can appear in the module field.
| #define TIB_ADVISORY_NAME_DATALOSS "DATALOSS" |
The advisory message reports data loss.
This string value can appear in the name field.
The reason field distinguishes among several reasons for data loss.
| #define TIB_ADVISORY_NAME_LOCK_LOST "LOCK_LOST" |
The advisory message reports that a lock previously held by this application was stolen by some other application.
This string value can appear in the name field.
| #define TIB_ADVISORY_NAME_RESOURCE_AVAILABLE "RESOURCE_AVAILABLE" |
The advisory message reports that a resource is available.
This string value can appear in the name field.
The reason field notes the available resource.
| #define TIB_ADVISORY_NAME_RESOURCE_UNAVAILABLE "RESOURCE_UNAVAILABLE" |
The advisory message reports that a resource is unavailable.
This string value can appear in the name field.
The reason field notes the unavailable resource.
| #define TIB_ADVISORY_NAME_RETRANSMISSION "RETRANSMISSION" |
The advisory message reports multicast retransmission.
This string value can appear in the name field.
Retransmission is a normal occurrence for multicast transports. Retransmission advisories give applications access to data about network conditions.
The reason field distinguishes the type of retransmission advisory.
| #define TIB_ADVISORY_NAME_SUBSCRIBER_FORCE_CLOSE "SUBSCRIBER_FORCE_CLOSE" |
The advisory message reports that a persistence store forced a durable subscriber to close.
This string value can appear in the name field.
The reason field indicates the reason that the store forced the durable subscriber to close.
| #define TIB_ADVISORY_REASON_DIRECT_SUB_LOSS "DIRECT_SUBSCRIBER_LOSS" |
The advisory reports data loss; the reason is direct subscriber detected data loss in the inbound stream.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_DURABLE_SUBSCRIBER_COLLISION "DURABLE_SUBSCRIBER_COLLISION" |
The advisory reports that a persistence store forced a subscriber to close; the reason is durable subscriber collision.
Each durable can serve at most one durable subscriber object at a time. The store resolves collisions in favor of the newer durable subscriber, forcing the older subscriber to close.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_FAILOVER_LOSS "FAILOVER_LOSS" |
The advisory reports potential data loss; the reason is failover to a backup forwarding component.
Only connection-oriented transports can detect this condition.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_INCOMPLETE_MESSAGE "INCOMPLETE_MESSAGE" |
The advisory reports data loss; the reason is an incomplete message.
The transport could not reassemble an inbound message because some data fragments did not arrive.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_LOCK_LOST_ON_DISCONNECT "LOCK_LOST_ON_DISCONNECT" |
The advisory reports lock lost notification; the reason is a lock that was previously held by this application was lost because of a disconnect from the persistence store.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_LOCK_STOLEN "LOCK_STOLEN" |
The advisory reports lock lost notification; the reason is a lock that was previously held by this application was stolen by some other application.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_PERSISTENCE_STORE_AVAILABLE "PERSISTENCE_STORE_AVAILABLE" |
The advisory reports resource availability; the reason is that a persistence store is available.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_PERSISTENCE_STORE_AVAILABLE_AFTER_CLUSTER_DATALOSS "PERSISTENCE_STORE_AVAILABLE_AFTER_CLUSTER_DATALOSS" |
The advisory reports resource availability; the reason is that a persistence store is available but the cluster lost some or all data.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_PERSISTENCE_STORE_UNAVAILABLE "PERSISTENCE_STORE_UNAVAILABLE" |
The advisory reports resource unavailability; the reason is that a persistence store is not available.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_QUEUE_LIMIT_EXCEEDED "QUEUE_LIMIT_EXCEEDED" |
The advisory message reports data loss; the reason is overflow of an event queue.
The queue has discarded some events, in accordance with its property values.
This string value can appear in the reason field.
Common Diagnoses
| #define TIB_ADVISORY_REASON_RECONNECT_LOSS "RECONNECT_LOSS" |
The advisory reports potential data loss; the reason is a temporary network disconnect between two connection-oriented transports (that is, TCP or RDMA).
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_RETRANSMISSION_REQUEST "RETRANSMISSION_REQUEST" |
The advisory reports that the subscribing endpoint of a multicast transport in the application requested retransmission from a publishing endpoint.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_RETRANSMISSION_REQUEST_SUPPRESSED "RETRANSMISSION_REQUEST_SUPPRESSED" |
The advisory reports that the subscribing endpoint of a multicast transport in the application would have requested retransmission, but request was suppressed.
Suppression can occur when a multicast transport enables retransmission control, and a subscribing endpoint misses packets in excess of a specified threshold.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_RETRANSMISSION_SENT "RETRANSMISSION_SENT" |
The advisory reports that the publishing endpoint of a multicast transport in the application has sent a retransmission as requested.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_SENDER_DISCARD "SENDER_DISCARD" |
The advisory reports data loss; the reason is a sending transport has discarded data in accordance with its backlog settings.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_STORE_DISCARD_DATALOSS "STORE_DISCARD_DATALOSS" |
The advisory reports data loss when a subscriber to a last-value durable has missed one or more messages from the persistence store.
It can also report potential data loss because the subscriber disconnected from the store.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_TPORT_DATALOSS "TPORT_DATALOSS" |
The advisory reports data loss; the reason is a transport malfunction.
This string value can appear in the reason field.
| #define TIB_ADVISORY_REASON_UPSTREAM_LOSS "UPSTREAM_LOSS" |
The advisory reports potential data loss; the reason is a data loss advisory detected upstream at a forwarding component (such as a transport bridge).
This string value can appear in the reason field.
| #define TIB_ADVISORY_SEVERITY_DEBUG "DEBUG" |
The advisory message is for debugging (severity value).
Debug advisories can report internal state changes, or signal an administrator to investigate. Debug advisories do not indicate impaired behavior.
This string value can appear in the severity field.
| #define TIB_ADVISORY_SEVERITY_INFO "INFO" |
The advisory message is informational (severity value).
Informational advisories can report external state changes, or signal your program to change its operating state. Informational advisories do not indicate impaired FTL behavior.
This string value can appear in the severity field.
| #define TIB_ADVISORY_SEVERITY_WARN "WARN" |
The advisory message is a warning (severity value).
Warnings indicate that although FTL functionality is impaired, FTL still continues to operate. As a result of impaired messaging, your application might behave incorrectly.
This string value can appear in the severity field.