Functions

EmberAfMailboxStatus emberAfPluginMailboxClientMessageSubmit (EmberNodeId mailboxServer, EmberNodeId messageDestination, uint8_t *message, EmberMessageLength messageLength, uint8_t tag, bool useSecurity)
 Submits a data message to a mailbox server. If this API returns an EmberAfMailboxStatus value of EMBER_MAILBOX_STATUS_SUCCESS, the corresponding asynchronous callback emberAfPluginMailboxClientMessageSubmitCallback() will be invoked to indicate whether the message was successfully submitted to the mailbox server or to inform the application of the reason of failure. More...
 
EmberAfMailboxStatus emberAfPluginMailboxClientCheckInbox (EmberNodeId mailboxServer, bool useSecurity)
 Queries a mailbox server for pending messages. If this API returns an EmberAfMailboxStatus value of EMBER_MAILBOX_STATUS_SUCCESS, the corresponding asynchronous callback emberAfPluginMailboxClientCheckInboxCallback() will be invoked either to provide the retrieved message or to indicate the reason for failure. More...
 
void emberAfPluginMailboxClientMessageSubmitCallback (EmberAfMailboxStatus status, EmberNodeId mailboxServer, EmberNodeId messageDestination, uint8_t tag)
 Mailbox Client Message Submit Callback. More...
 
void emberAfPluginMailboxClientMessageDeliveredCallback (EmberAfMailboxStatus status, EmberNodeId mailboxServer, EmberNodeId messageDestination, uint8_t tag)
 Mailbox Client Message Delivered Callback. More...
 
void emberAfPluginMailboxClientCheckInboxCallback (EmberAfMailboxStatus status, EmberNodeId mailboxServer, EmberNodeId messageSource, uint8_t *message, EmberMessageLength messageLength, uint8_t tag, bool moreMessages)
 Mailbox Client Check Inbox Callback. More...
 

Detailed Description

See mailbox-client.h for source code.

Function Documentation

EmberAfMailboxStatus emberAfPluginMailboxClientCheckInbox ( EmberNodeId  mailboxServer,
bool  useSecurity 
)

Queries a mailbox server for pending messages. If this API returns an EmberAfMailboxStatus value of EMBER_MAILBOX_STATUS_SUCCESS, the corresponding asynchronous callback emberAfPluginMailboxClientCheckInboxCallback() will be invoked either to provide the retrieved message or to indicate the reason for failure.

Parameters
mailboxServerThe mailbox server short ID to be queried.
useSecurityA flag indicating whether the request command should be sent secured. Note that secured pending messages can only be retrieved performing a secured query while unsecured pending messages can be retrieved using either an unsecured or a secured query.
Returns
An EmberAfMailboxStatus value of:
void emberAfPluginMailboxClientCheckInboxCallback ( EmberAfMailboxStatus  status,
EmberNodeId  mailboxServer,
EmberNodeId  messageSource,
uint8_t *  message,
EmberMessageLength  messageLength,
uint8_t  tag,
bool  moreMessages 
)

Mailbox Client Check Inbox Callback.

This callback is invoked asynchronously after a successful call to the emberAfPluginMailboxClientCheckInbox() API. If a message was retrieved from the mailbox server, this callback passes it to the application. Otherwise, it indicates the reason for failure to the application.

Parameters
statusAn EmberAfMailboxStatus value of:
messageSourceThe source node address of the retrieved message. Note that this parameter is meaningful only if the status parameter has an EmberAfMailboxStatus value of EMBER_MAILBOX_STATUS_SUCCESS.
messageA pointer to the retrieved message payload. Note that this parameter is meaningful only if the status parameter has an EmberAfMailboxStatus value of EMBER_MAILBOX_STATUS_SUCCESS.
messageLengthThe length in bytes of the retrived message payload. Note that this parameter is meaningful only if the status parameter has an EmberAfMailboxStatus value of EMBER_MAILBOX_STATUS_SUCCESS.
tagThe tag value used by the source mailbox client. Note that this parameter is meaningful only if the status parameter has an EmberAfMailboxStatus value of EMBER_MAILBOX_STATUS_SUCCESS.
moreMessagesThis flag indicates whether the mailbox server has more pending messages for this mailbox client. Note that this parameter is meaningful only if the status parameter has an EmberAfMailboxStatus value of EMBER_MAILBOX_STATUS_SUCCESS.
void emberAfPluginMailboxClientMessageDeliveredCallback ( EmberAfMailboxStatus  status,
EmberNodeId  mailboxServer,
EmberNodeId  messageDestination,
uint8_t  tag 
)

Mailbox Client Message Delivered Callback.

A callback that may be invoked either if the a message that was submitted to a mailbox server reached its final destination or it timed-out. Note that the callback is not always called. If the status message from the server is lost, the callback won't be called.

Parameters
statusAn EmberAfMailboxStatus value of:
mailboxServerThe mailbox server short ID where the message was submitted to.
messageDestinationThe message destination.
tagThe message tag.
EmberAfMailboxStatus emberAfPluginMailboxClientMessageSubmit ( EmberNodeId  mailboxServer,
EmberNodeId  messageDestination,
uint8_t *  message,
EmberMessageLength  messageLength,
uint8_t  tag,
bool  useSecurity 
)

Submits a data message to a mailbox server. If this API returns an EmberAfMailboxStatus value of EMBER_MAILBOX_STATUS_SUCCESS, the corresponding asynchronous callback emberAfPluginMailboxClientMessageSubmitCallback() will be invoked to indicate whether the message was successfully submitted to the mailbox server or to inform the application of the reason of failure.

Parameters
mailboxServerThe mailbox server short ID.
messageDestinationThe data message destination short ID.
messageA pointer to the message to be sent.
messageLengthThe length in bytes of the message to be sent.
tagA tag value the application can use to match asynchronous callbacks.
useSecurityA flag indicating whether the data message should be sent to the server using security or not.
Returns
An EmberAfMailboxStatus value of:
void emberAfPluginMailboxClientMessageSubmitCallback ( EmberAfMailboxStatus  status,
EmberNodeId  mailboxServer,
EmberNodeId  messageDestination,
uint8_t  tag 
)

Mailbox Client Message Submit Callback.

A callback invoked after a successful emberAfPluginMailboxClientMessageSubmit() API call.

Parameters
statusAn EmberAfMailboxStatus value of:
mailboxServerThe mailbox server short ID.
messageDestinationThe message destination short ID.
tagThe tag value passed in the emberAfPluginMailboxClientMessageSubmit() API.