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] destination An EmberNodeId value indicating the address of the message's destination node.
[in] message A 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] messageLength The length in bytes of the message to be enqueued.
[in] tag A tag value for the passed message.
[in] useSecurity Indicates whether the message should be sent secured or not.
Returns
An EmberAfMailboxStatus value of:
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] status An EmberAfMailboxStatus value of:
[in] messageDestination The message destination.
[in] tag The message tag.