embenet_br_event_handlers.h File Reference
Table of contents
Table of contents
Definition of event handlers for border router. More...
Data Structures | |
| struct | EMBENET_BR_EventHandlers |
| Structure holding embeNET Border Router stack event handlers. More... | |
Typedefs | |
| typedef void(* | EMBENET_BR_OnNetworkStarted) (void) |
| Called when network has successfully started. More... | |
| typedef void(* | EMBENET_BR_OnNetworkStopped) (void) |
| Called when network stops due to an error. More... | |
| typedef void(* | EMBENET_BR_OnNodeJoined) (EMBENET_EUI64 uid) |
| Called when a node joins the network. More... | |
| typedef void(* | EMBENET_BR_OnNodeLeft) (EMBENET_EUI64 uid) |
| Called when a node leaves the network. More... | |
| typedef void(* | EMBENET_BR_OnNodeAddedToGroup) (EMBENET_GroupId groupId, EMBENET_EUI64 uid) |
| Called when a node is added to a group. More... | |
| typedef void(* | EMBENET_BR_OnNodeRemovedFromGroup) (EMBENET_GroupId groupId, EMBENET_EUI64 uid) |
| Called when a node is removed from a group. More... | |
| typedef void(* | EMBENET_BR_OnDataOnUnregisteredPort) (uint16_t port) |
| Called when a UDP datagram was received on an unregistered port. More... | |
Detailed Description
Definition of event handlers for border router.
- License: Commercial
- Copyright
- (c) 2023 EMBETECH SP. Z O.O. All rights reserved.
- Version
- 1.0.3624
- Purpose: embeNET API
Typedef Documentation
◆ EMBENET_BR_OnNetworkStarted
| typedef void(* EMBENET_BR_OnNetworkStarted) (void) |
Called when network has successfully started.
◆ EMBENET_BR_OnNetworkStopped
| typedef void(* EMBENET_BR_OnNetworkStopped) (void) |
Called when network stops due to an error.
- Note
- To make the network operational after it stops EMBENET_BR_StopNetwork should be called and then Border Router may be started once again (EMBENET_BR_StartNetwork).
◆ EMBENET_BR_OnNodeJoined
| typedef void(* EMBENET_BR_OnNodeJoined) (EMBENET_EUI64 uid) |
Called when a node joins the network.
- Parameters
-
[in] uid UID of the joining node
◆ EMBENET_BR_OnNodeLeft
| typedef void(* EMBENET_BR_OnNodeLeft) (EMBENET_EUI64 uid) |
Called when a node leaves the network.
- Parameters
-
[in] uid UID of the leaving node
◆ EMBENET_BR_OnNodeAddedToGroup
| typedef void(* EMBENET_BR_OnNodeAddedToGroup) (EMBENET_GroupId groupId, EMBENET_EUI64 uid) |
Called when a node is added to a group.
- Parameters
-
[in] groupId ID of the group [in] uid UID of the node
◆ EMBENET_BR_OnNodeRemovedFromGroup
| typedef void(* EMBENET_BR_OnNodeRemovedFromGroup) (EMBENET_GroupId groupId, EMBENET_EUI64 uid) |
Called when a node is removed from a group.
- Parameters
-
[in] groupId ID of the group [in] uid UID of the node
◆ EMBENET_BR_OnDataOnUnregisteredPort
| typedef void(* EMBENET_BR_OnDataOnUnregisteredPort) (uint16_t port) |
Called when a UDP datagram was received on an unregistered port.
- Parameters
-
[in] port port number.
Generated on Wed Feb 8 2023 19:52:39 for embeNET Border Router C API by
1.9.3