The broadcast module sends packets to all local area neighbors with an a header that identifies the sender.
The broadcast module sends a packet to all local neighbors. The module adds the single-hop sender address as a packet attribute to outgoing packets. All Rime primitives that need the identity of the sender in the outgoing packets use the broadcast primitive, either directly or indirectly through any of the other communication primitives that are based on the broadcast primitive.
Channels
The broadcast module uses 1 channel.
|
file | broadcast.h |
| Header file for identified best-effort local area broadcast
|
|
#define BROADCAST_ATTRIBUTES |
Value:
Definition: packetbuf.h:377
#define PACKETBUF_ADDRSIZE
Definition: packetbuf.h:446
#define ABC_ATTRIBUTES
Definition: abc.h:65
Close a broadcast connection.
- Parameters
-
c | A pointer to a struct broadcast_conn This function closes a broadcast connection that has
previously been opened with broadcast_open().
This function typically is called as an exit handler. |
Set up an identified best-effort broadcast connection.
- Parameters
-
c | A pointer to a struct broadcast_conn |
channel | The channel on which the connection will operate |
u | A struct broadcast_callbacks with function pointers to functions that will be called when a packet has been received This function sets up a broadcast connection on the
specified channel. The caller must have allocated the
memory for the struct broadcast_conn, usually by declaring it
as a static variable.
The struct broadcast_callbacks pointer must point to a structure
containing a pointer to a function that will be called
when a packet arrives on the channel. |
Send an identified best-effort broadcast packet.
- Parameters
-
c | The broadcast connection on which the packet should be sent |
- Return values
-
Non-zero | if the packet could be sent, zero otherwise This function sends an identified best-effort broadcast
packet. The packet must be present in the packetbuf
before this function is called.
The parameter c must point to a broadcast connection that
must have previously been set up with broadcast_open(). |