migratorydata
Classes
Name | |
---|---|
class | migratorydata::MigratoryDataClient This class implements all the necessary operations for connecting to a cluster of one or more MigratoryData servers, subscribing to subjects, getting real-time messages for the subscribed subjects, and publishing real-time messages. |
class | migratorydata::MigratoryDataListener The implementation of this interface will handle the messages received from the server for the subscribed subjects as well as various status notifications. |
class | migratorydata::MigratoryDataLogListener The implementation of this interface will handle the log messages produced by the library. |
class | migratorydata::MigratoryDataMessage Represent a message. |
Types
Name | |
---|---|
enum | MigratoryDataLogLevel { LOG_ERROR, LOG_INFO, LOG_DEBUG, LOG_TRACE } This class enumerates the MigratoryData logging levels. |
enum | MessageType { SNAPSHOT = 1, UPDATE, RECOVERED, HISTORICAL } Return a string representation of the message. |
enum | QoS { STANDARD = 0, GUARANTEED } The quality of service (QoS) levels for MigratoryData messaging. |
Types Documentation
enum MigratoryDataLogLevel
Enumerator | Value | Description |
---|---|---|
LOG_ERROR | The LOG_ERROR level turns on the error logs of the API. |
|
LOG_INFO | The LOG_INFO level turns on the info, warning, and error logs of the API. |
|
LOG_DEBUG | The LOG_DEBUG level turns on the debug, info, warning, and error logs of the API. |
|
LOG_TRACE | The LOG_TRACE level turns on all the logs of the API. |
This class enumerates the MigratoryData logging levels.
The available log levels ordered by verbosity are:
- LOG_ERROR (less verbose)
- LOG_INFO
- LOG_DEBUG
- LOG_TRACE (most verbose)
enum MessageType
Enumerator | Value | Description |
---|---|---|
SNAPSHOT | 1 | the message from the server is snapshot type |
UPDATE | the message from the server is update type | |
RECOVERED | the message from the server is recovered type | |
HISTORICAL | the message from the server is historical type |
Return a string representation of the message.
enum QoS
Enumerator | Value | Description |
---|---|---|
STANDARD | 0 | The QoS.STANDARD should be used for noncritical messages which will not be included in the cache of the MigratoryData cluster. In this way, after a connection recovery, a client will not receive as part of the recovery process the messages with QoS.STANDARD . |
Note: This QoS level corresponds to the at-most-once
delivery semantics. |
| GUARANTEED | | The QoS.GUARANTEED
should be used for critical messages which will be included in the cache of the MigratoryData cluster. In this way, after a connection recovery, a client will receive as part of the recovery process the messages with QoS.GUARANTEED
.
Note: This QoS level corresponds to the at-least-once
delivery semantics. Also, it might correspond to the exactly-once
delivery semantics provided that subscribers are responsible for filtering out duplicate receptions, if it at all matters for the application. Typically, a small buffer containing the identifiers of recently-received messages is sufficient for this task. |
The quality of service (QoS) levels for MigratoryData messaging.