Getting started
A typical API usage is as follows:
Step 1 - Include the library
Include the headers of the API located in the folder lib
of this API
package.
Add the lib
folder to the Include Directories of your iOS
application.
The API library is available in the folder lib
of this API package.
Add the lib
folder to the Library Directories of your iOS
application. Also, add the API library itself to the list of Library
Dependencies of your iOS application.
Step 2 - Define a listener to get messages and status notifications
The listener should implement the MigratoryDataListener
interface.
Use the API call MigratoryDataClient::setListener:
to attach your
listener implementation.
Step 3 - Specify where to connect to
Use the API method MigratoryDataClient::setServers:
to specify a list
of one or more MigratoryData servers to which the client will connect
to. In fact, the client will connect to only one of the MigratoryData
servers in this list. But, defining two or more MigratoryData servers is
recommended in order to achieve fail-over. Supposing the MigratoryData
server to which the client connected goes down, then the API will
automatically reconnect to another MigratoryData server in the list.
Step 4 - Connect to the MigratoryData cluster
Use the API method MigratoryDataClient::connect()
to connect to the
cluster and start receiving real-time messages from the MigratoryData
cluster as well as status notifications.
Step 5 - Subscribe to subjects and publish messages
Use the API method MigratoryDataClient::subscribe:
to specify interest
in receiving real-time messages having as subjects the strings provided
in the parameter of this API method. You can call the API method
MigratoryDataClient::subscribe:
at any time to subscribe to further
subjects. To unsubscribe from subscribed subjects, use the API method
MigratoryDataClient::unsubscribe():
.
Use the API method MigratoryDataClient::publish:
to publish messages.
Step 6 - Handle the real-time messages and status notifications
Handle the messages received for the subscribed subjects as well as the status notifications in your listener implementation defined at Step 2 above.
Examples
Examples built with this API are available in the folder examples
of
this API package; start with the README file which explains how to run
them.