Mailbox Server Plugin
APIs for mailbox server. More...
Functions | |
| EmberAfMailboxStatus | emberAfPluginMailboxServerAddMessage (EmberNodeId destination, uint8_t *message, EmberMessageLength messageLength, uint8_t tag, bool useSecurity) |
| Adds a message to the mailbox queue. The message is stored in the internal queue until the destination node queries the mailbox server node for messages or upon timeout. More... | |
| void | emberAfPluginMailboxServerMessageDeliveredCallback (EmberAfMailboxStatus status, EmberNodeId messageDestination, uint8_t tag) |
| Mailbox Server Message Delivered Callback. More... | |
Detailed Description
APIs for mailbox server.
License
Copyright 2018 Silicon Laboratories Inc. www.silabs.com
The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code.
See mailbox-server.h for source code.
Function Documentation
| EmberAfMailboxStatus emberAfPluginMailboxServerAddMessage | ( | EmberNodeId | destination, |
| uint8_t * | message, |
||
| EmberMessageLength | messageLength, |
||
| uint8_t | tag, |
||
| bool | useSecurity |
||
| ) |
Adds a message to the mailbox queue. The message is stored in the internal queue until the destination node queries the mailbox server node for messages or upon timeout.
- Parameters
-
[in] destinationAn EmberNodeId value indicating the address of the message's destination node. [in] messageA pointer to the message to be enqueued. Note that, if the allocation memory plugin option is enabled, the packet content is copied in the internal plugin data structures. Otherwise, the plugin stores the pointer. In this case, the application is responsible to ensure that this pointer is valid until the message is delivered to the final destination or upon timeout. [in] messageLengthThe length in bytes of the message to be enqueued. [in] tagA tag value for the passed message. [in] useSecurityIndicates whether the message should be sent secured or not.
- Returns
- An EmberAfMailboxStatus value of:
- EMBER_MAILBOX_STATUS_SUCCESS if the message was successfully added to the packet queue.
- EMBER_MAILBOX_STATUS_INVALID_CALL if the passed message is invalid.
- EMBER_MAILBOX_STATUS_INVALID_ADDRESS if the passed destination address is invalid.
- EMBER_MAILBOX_STATUS_MESSAGE_TOO_LONG if the payload size of the passed message exceeds the maximum allowable payload for the passed transmission options.
- EMBER_MAILBOX_STATUS_MESSAGE_TABLE_FULL if the packet table is already full.
- EMBER_MAILBOX_STATUS_MESSAGE_NO_BUFFERS if not enough memory buffers are available for storing the message content.
| void emberAfPluginMailboxServerMessageDeliveredCallback | ( | EmberAfMailboxStatus | status, |
| EmberNodeId | messageDestination, |
||
| uint8_t | tag |
||
| ) |
Mailbox Server Message Delivered Callback.
This callback is invoked at the server when a message submitted locally by the server was successfully delivered or when it timed-out.
- Parameters
-
[in] statusAn EmberAfMailboxStatus value of: - EMBER_MAILBOX_STATUS_SUCCESS indicates that the message was successfully delivered to the final destination.
- EMBER_MAILBOX_STATUS_MESSAGE_TIMED_OUT indicates that the message timed-out and was removed from the server queue.
[in] messageDestinationThe message destination. [in] tagThe message tag.