PingPong 1.0.0 documentation

Requester example that initiates the request/reply pattern on a different channel than the reply is using

Table of Contents

• Servers
  • development
• Operations
  • REQUEST heartbeat
  • REQUEST ping

Servers

development Server

• URL: mqtt://127.0.0.1/
• Protocol: mqtt

Development MQTT broker.

Server tags

| Name | Description | Documentation | |---|---|---| | env:staging | This environment is a replica of the production environment | - |

Operations

REQUEST ping Operation

• Operation ID: ping

Send ping and wait for pong

Message Ping message ping

Message sent from client

Payload

| Name | Type | Description | Value | Constraints | Notes | |---|---|---|---|---|---| | (root) | object | - | - | - | additional properties are allowed | | event | string | - | const ("ping") | - | - |

Examples of payload (generated)

{
  "event": "ping"
}

Request information

• request should be done to channel: pong

Message Pong message pong

Message sent from server

Payload

| Name | Type | Description | Value | Constraints | Notes | |---|---|---|---|---|---| | (root) | object | - | - | - | additional properties are allowed | | event | string | - | const ("pong") | - | - |

Examples of payload (generated)

{
  "event": "pong"
}

REQUEST heartbeat Operation

• Operation ID: heartbeat

Request contains one of the following messages:

Message Request for a heartbeat heartbeatRequest

Client sends to subscribe to heartbeats from server

Payload

| Name | Type | Description | Value | Constraints | Notes | |---|---|---|---|---|---| | (root) | object | - | - | - | additional properties are allowed | | heartbeat | string | - | - | pattern (please) | - |

Examples of payload (generated)

{
  "heartbeat": "string"
}

Message Heartbeat message heartbeat

Server sends it to client periodically

Payload

| Name | Type | Description | Value | Constraints | Notes | |---|---|---|---|---|---| | (root) | object | - | - | - | additional properties are allowed | | count | integer | - | - | - | - |

Examples of payload (generated)

{
  "count": 0
}

Request information

• request should be done to channel: heartbeat Receive one of the following messages as a response to the request:

Message Request for a heartbeat heartbeatRequest

Client sends to subscribe to heartbeats from server

Payload

| Name | Type | Description | Value | Constraints | Notes | |---|---|---|---|---|---| | (root) | object | - | - | - | additional properties are allowed | | heartbeat | string | - | - | pattern (please) | - |

Examples of payload (generated)

{
  "heartbeat": "string"
}

Message Heartbeat message heartbeat

Server sends it to client periodically

Payload

| Name | Type | Description | Value | Constraints | Notes | |---|---|---|---|---|---| | (root) | object | - | - | - | additional properties are allowed | | count | integer | - | - | - | - |

Examples of payload (generated)

{
  "count": 0
}