Import Ping
- Sacha Parisot (Unlicensed)
Using ping without a response request could be useful as a keepalive signal. But the typical use-case includes a response topic to allow for a ping response.
Ping Request Arguments
A ping request can include the following arguments.
Argument | Type | Description |
|---|---|---|
step | string | (Required) Must be set to ping. |
respond | string | (Optional) A topic where the response object is expected. The response topic is allocated by the initiator (the CMS). It must be within the feedback channel for this edge server to allow communication across bridged message brokers. Example: |
meta | any | (Optional) If provided, the meta data is returned with the response. |
Ping Response
When the ping request includes a response topic, the edge server publishes the response object to the requested respond topic when ready.
Parameter | Type | Description |
|---|---|---|
step | string | (Required) The step from the corresponding request. |
meta | any | (Optional) Meta data from the corresponding request, if any. |
error | string | (Optional) Error description. Undefined if no error occurred. Errors not in direct relation to this request are reported through the IAP/MQ event channel, captured by the IAP/REST engine and reported with the IAP/REST import responses. |