ab_gp_sibling_state.c File Reference

See ab_gp_sibling_state.h. More...

#include "ab_gp_sibling_state.h"

Include dependency graph for ab_gp_sibling_state.c:

Go to the source code of this file.

Functions
void	ab_gp_sibling_state_reset (ab_gp_sibling_state_t *st)
	Resets the state to "no frame seen" (all zero).
bool	ab_gp_sibling_state_store (ab_gp_sibling_state_t *st, const uint8_t *payload, size_t size)
	Stores a received site-state frame payload: the rule of on_peer_frame_received() (the payload must carry at least the whole frame). A later store before a take replaces the earlier bytes.
bool	ab_gp_sibling_state_take (ab_gp_sibling_state_t *st, rte_site_role_sibling_t *out)
	The rte_site_role_sibling_source_fn contract: hands out the frame stored since the previous take.

Detailed Description

See ab_gp_sibling_state.h.

Definition in file ab_gp_sibling_state.c.

Function Documentation

ab_gp_sibling_state_reset()

void ab_gp_sibling_state_reset

(

ab_gp_sibling_state_t *

st

)

Resets the state to "no frame seen" (all zero).

Parameters

st	the state; NULL is ignored

Definition at line 7 of file ab_gp_sibling_state.c.

ab_gp_sibling_state_store()

bool ab_gp_sibling_state_store	(	ab_gp_sibling_state_t *	st,
		const uint8_t *	payload,
		size_t	size )

Stores a received site-state frame payload: the rule of on_peer_frame_received() (the payload must carry at least the whole frame). A later store before a take replaces the earlier bytes.

Parameters

st	the state
payload	the frame payload (the bytes after the message kind)
size	number of bytes available in payload

Returns

true when size is at least RTE_EXAMPLE_AB_SITE_STATE_WIRE_SIZE and the first RTE_EXAMPLE_AB_SITE_STATE_WIRE_SIZE bytes were copied (known and fresh set); false otherwise (NULL argument or a short payload: the state is left unchanged)

Definition at line 22 of file ab_gp_sibling_state.c.

ab_gp_sibling_state_take()

bool ab_gp_sibling_state_take	(	ab_gp_sibling_state_t *	st,
		rte_site_role_sibling_t *	out )

The rte_site_role_sibling_source_fn contract: hands out the frame stored since the previous take.

Parameters

st	the state
out	receives known = true, online = (byte 0 != 0), single_mode = (byte 1 == RTE_EXAMPLE_SINGLE_MODE_FLAG_SINGLE), ready = (byte 2 != 0) when the result is true; left untouched otherwise

Returns

true when a fresh frame was handed out (fresh is cleared, known stays); false when nothing fresh is held or an argument is NULL

Definition at line 41 of file ab_gp_sibling_state.c.