SharkSSL™ Embedded SSL/TLS Stack
Response codes returned by function SharkMQ_getMessage

Detailed Description

Response codes returned by function SharkMQ_getMessage

Macros

#define SMQ_SUBACK   -20000
 Asynchronous SharkMQ_subscribe response message received via SharkMQ_getMessage. More...
 
#define SMQ_CREATEACK   -20001
 Asynchronous SharkMQ_create response message received via SharkMQ_getMessage. More...
 
#define SMQ_CREATESUBACK   -20002
 Asynchronous SharkMQ_createsub response message received via SharkMQ_getMessage. More...
 
#define SMQ_SUBCHANGE   -20003
 Change notification event (from observed tid). More...
 
#define SMQ_TIMEOUT   -20004
 The SharkMQ_getMessage call timed out.
 

Macro Definition Documentation

◆ SMQ_CREATEACK

#define SMQ_CREATEACK   -20001

Asynchronous SharkMQ_create response message received via SharkMQ_getMessage.

  • SharkMQ::ptid is set to the created Topic ID.
  • SharkMQ::status is set to zero (0) if the request was accepted and a negative value if the request was denied.
  • the 'msg' out parameter in SharkMQ_getMessage is set to the optional server's authentication response message if the request was denied.

◆ SMQ_CREATESUBACK

#define SMQ_CREATESUBACK   -20002

Asynchronous SharkMQ_createsub response message received via SharkMQ_getMessage.

  • SharkMQ::ptid is set to the created Subtopic ID.
  • SharkMQ::status is set to zero (0) if the request was accepted and a negative value if the request was denied.

◆ SMQ_SUBACK

#define SMQ_SUBACK   -20000

Asynchronous SharkMQ_subscribe response message received via SharkMQ_getMessage.

  • SharkMQ::ptid is set to the subscribed Topic ID.
  • SharkMQ::status is set to zero (0) if the request was accepted and a negative value if the request was denied.
  • the 'msg' out parameter in SharkMQ_getMessage is set to the optional server's authentication response message if the request was denied.

◆ SMQ_SUBCHANGE

#define SMQ_SUBCHANGE   -20003

Change notification event (from observed tid).

Observe events are initiated via SharkMQ_observe.