pause method

void pause()

Pause the API operation.

If the application built with this API library enters into background, then it is recommended to use this API call. It will disconnect the user from the MigratoryData sever but will preserve the user’s context (including the cluster definition and subscribed subjects) in order to reconnect to the cluster later when the API method \link MigratoryDataClient.resume \endlink is called.

Moreover, if the cluster is configured with guaranteed message delivery, then when the user will reconnect to the cluster using \link MigratoryDataClient.resume \endlink, it will get all messages published since the \link MigratoryDataClient.pause \endlink method was called, provided however that the duration between the time when \link MigratoryDataClient.pause \endlink method was called and the \link MigratoryDataClient.resume \endlink method was called is less than the value defined by the parameter CacheExpireTime of the MigratoryData server configuration.

Implementation

void pause() {
  clientImpl.pause();
}