ACKme Logo WiConnect Host Library- API Reference Guide
 
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
Message

Methods for getting, posting, listing, deleting messages wtih http://goHACK.me. More...

Functions

WiconnectResult wiconnect::GhmInterface::ghmPostMessage (WiconnectSocket &socket, bool jsonFormatted=false)
 POST message to http://goHACK.me. More...
 
WiconnectResult wiconnect::GhmInterface::ghmGetMessage (WiconnectSocket &socket, GhmMessageGetType getType=GHM_MSG_GET_DATA_ONLY)
 GET message from http://goHACK.me. More...
 
WiconnectResult wiconnect::GhmInterface::ghmGetMessage (WiconnectSocket &socket, uint8_t listIndex, GhmMessageGetType getType=GHM_MSG_GET_DATA_ONLY)
 GET message from http://goHACK.me. More...
 
WiconnectResult wiconnect::GhmInterface::ghmGetMessage (WiconnectSocket &socket, const char *msgId, GhmMessageGetType getType=GHM_MSG_GET_DATA_ONLY)
 GET message from http://goHACK.me. More...
 
WiconnectResult wiconnect::GhmInterface::ghmDeleteMessage (uint8_t listIndex)
 Delete message from http://goHACK.me. More...
 
WiconnectResult wiconnect::GhmInterface::ghmDeleteMessage (const char *msgId)
 Delete message from http://goHACK.me. More...
 
WiconnectResult wiconnect::GhmInterface::ghmListMessages (GhmMessageList &msgList, uint8_t maxCount=0)
 List available messages for device on http://goHACK.me. More...
 

Detailed Description

Methods for getting, posting, listing, deleting messages wtih http://goHACK.me.

Function Documentation

WiconnectResult wiconnect::GhmInterface::ghmDeleteMessage ( uint8_t  listIndex)

Delete message from http://goHACK.me.

Note
ghmListMessages() must be called first before using this method.
The WiFi module must first be activated. See ghmActivate()
Parameters
[in]listIndexThe index of the message returned from ghmListMessages()
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::GhmInterface::ghmDeleteMessage ( const char *  msgId)

Delete message from http://goHACK.me.

Note
The WiFi module must first be activated. See ghmActivate()
Parameters
[in]msgIdThe http://goHACK.me message ID.
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::GhmInterface::ghmGetMessage ( WiconnectSocket socket,
GhmMessageGetType  getType = GHM_MSG_GET_DATA_ONLY 
)

GET message from http://goHACK.me.

Note
The WiFi module must first be activated. See ghmActivate()
Parameters
[out]socketWiconnectSocket used to receive message data from http://goHACK.me
[in]getTypeThe additional message data to receive. See GhmMessageGetType
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::GhmInterface::ghmGetMessage ( WiconnectSocket socket,
uint8_t  listIndex,
GhmMessageGetType  getType = GHM_MSG_GET_DATA_ONLY 
)

GET message from http://goHACK.me.

Note
ghmListMessages() must be called first before using this method.
The WiFi module must first be activated. See ghmActivate()
Parameters
[out]socketWiconnectSocket used to receive message data from http://goHACK.me
[in]listIndexThe index of the message returned from ghmListMessages()
[in]getTypeThe additional message data to receive. See GhmMessageGetType
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::GhmInterface::ghmGetMessage ( WiconnectSocket socket,
const char *  msgId,
GhmMessageGetType  getType = GHM_MSG_GET_DATA_ONLY 
)

GET message from http://goHACK.me.

Note
The WiFi module must first be activated. See ghmActivate()
Parameters
[out]socketWiconnectSocket used to receive message data from http://goHACK.me
[in]msgIdThe http://goHACK.me message ID.
[in]getTypeThe additional message data to receive. See GhmMessageGetType
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::GhmInterface::ghmListMessages ( GhmMessageList msgList,
uint8_t  maxCount = 0 
)

List available messages for device on http://goHACK.me.

Note
The WiFi module must first be activated. See ghmActivate()
Parameters
[out]msgListGhmMessageList to hold received messages.
[in]maxCountOptional, the maximum number of messages to receive. If 0, receive all messages (max of 25).
Returns
Result of method. See WiconnectResult
WiconnectResult wiconnect::GhmInterface::ghmPostMessage ( WiconnectSocket socket,
bool  jsonFormatted = false 
)

POST message to http://goHACK.me.

Note
The WiFi module must first be activated. See ghmActivate()
Parameters
[out]socketWiconnectSocket used to send message data to http://goHACK.me
[in]jsonFormattedIf true, the input message data should be JSON formatted, else the message data should be ASCII formatted.
Returns
Result of method. See WiconnectResult