Best-effort local area broadcast
[The Rime communication stack]

The broadcast module sends packets to all local area neighbors with an a header that identifies the sender. More...

Data Structures
struct	broadcast_callbacks
	Callback structure for broadcast. More...
Files
file	broadcast.h
	Header file for identified best-effort local area broadcast.
Functions
void	broadcast_open (struct broadcast_conn *c, uint16_t channel, const struct broadcast_callbacks *u)
	Set up an identified best-effort broadcast connection.
void	broadcast_close (struct broadcast_conn *c)
	Close a broadcast connection.
int	broadcast_send (struct broadcast_conn *c)
	Send an identified best-effort broadcast packet.

---

Detailed Description

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.

---

Function Documentation

void broadcast_close

(

struct broadcast_conn *

c

)

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.

Definition at line 104 of file broadcast.c.

References abc_close().

void broadcast_open	(	struct broadcast_conn *	c,
		uint16_t	channel,
		const struct broadcast_callbacks *	u
	)

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.

Definition at line 95 of file broadcast.c.

References abc_open().

int broadcast_send

(

struct broadcast_conn *

c

)

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().

Definition at line 110 of file broadcast.c.

References abc_send(), and rimeaddr_node_addr.