![]() |
WiConnect Host Library- API Reference Guide | ||
Methods for getting, posting, listing, deleting messages wtih http://goHACK.me. More...
Methods for getting, posting, listing, deleting messages wtih http://goHACK.me.
WiconnectResult wiconnect::GhmInterface::ghmDeleteMessage | ( | uint8_t | listIndex | ) |
Delete message from http://goHACK.me.
[in] | listIndex | The index of the message returned from ghmListMessages() |
WiconnectResult wiconnect::GhmInterface::ghmDeleteMessage | ( | const char * | msgId | ) |
Delete message from http://goHACK.me.
[in] | msgId | The http://goHACK.me message ID. |
WiconnectResult wiconnect::GhmInterface::ghmGetMessage | ( | WiconnectSocket & | socket, |
GhmMessageGetType | getType = GHM_MSG_GET_DATA_ONLY |
||
) |
GET message from http://goHACK.me.
[out] | socket | WiconnectSocket used to receive message data from http://goHACK.me |
[in] | getType | The additional message data to receive. See GhmMessageGetType |
WiconnectResult wiconnect::GhmInterface::ghmGetMessage | ( | WiconnectSocket & | socket, |
uint8_t | listIndex, | ||
GhmMessageGetType | getType = GHM_MSG_GET_DATA_ONLY |
||
) |
GET message from http://goHACK.me.
[out] | socket | WiconnectSocket used to receive message data from http://goHACK.me |
[in] | listIndex | The index of the message returned from ghmListMessages() |
[in] | getType | The additional message data to receive. See GhmMessageGetType |
WiconnectResult wiconnect::GhmInterface::ghmGetMessage | ( | WiconnectSocket & | socket, |
const char * | msgId, | ||
GhmMessageGetType | getType = GHM_MSG_GET_DATA_ONLY |
||
) |
GET message from http://goHACK.me.
[out] | socket | WiconnectSocket used to receive message data from http://goHACK.me |
[in] | msgId | The http://goHACK.me message ID. |
[in] | getType | The additional message data to receive. See GhmMessageGetType |
WiconnectResult wiconnect::GhmInterface::ghmListMessages | ( | GhmMessageList & | msgList, |
uint8_t | maxCount = 0 |
||
) |
List available messages for device on http://goHACK.me.
[out] | msgList | GhmMessageList to hold received messages. |
[in] | maxCount | Optional, the maximum number of messages to receive. If 0, receive all messages (max of 25). |
WiconnectResult wiconnect::GhmInterface::ghmPostMessage | ( | WiconnectSocket & | socket, |
bool | jsonFormatted = false |
||
) |
POST message to http://goHACK.me.
[out] | socket | WiconnectSocket used to send message data to http://goHACK.me |
[in] | jsonFormatted | If true, the input message data should be JSON formatted, else the message data should be ASCII formatted. |