rbc_rbc.h File Reference

Subset-098 RBC/RBC Safe Communication Interface profile. More...

#include <stdint.h>
#include "safecomm/status.h"
#include "safecomm/saf/saf.h"

Include dependency graph for rbc_rbc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	safecomm_rr_config_t
	Subset-098 profile parameters. More...

Enumerations
enum	safecomm_rr_role_t { SAFECOMM_RR_ROLE_HANDING_OVER = 0 , SAFECOMM_RR_ROLE_ACCEPTING }
	Role of this RBC in the handover. More...

Functions
safecomm_status_t	safecomm_rr_make_saf_config (const safecomm_rr_config_t *cfg, safecomm_saf_config_t *out_saf)
	Build a SaF config for a Subset-098 RBC/RBC connection.

Detailed Description

Subset-098 RBC/RBC Safe Communication Interface profile.

The safe communication layer for the fixed-network link between two RBCs during handover (companion to the Subset-039 handover functional logic, which lives in the application, not here). Reuses the shared safecomm_saf_conn_t with the Subset-098 parameter set over a fixed IP safecomm_transport_t.

REQ-SC-RR-001..020 — see docs/requirements/SRS.md.

Definition in file rbc_rbc.h.

Enumeration Type Documentation

safecomm_rr_role_t

enum safecomm_rr_role_t

Role of this RBC in the handover.

Enumerator
SAFECOMM_RR_ROLE_HANDING_OVER	Current controlling RBC — SaF initiator.
SAFECOMM_RR_ROLE_ACCEPTING	Neighbour RBC — SaF responder.

Definition at line 26 of file rbc_rbc.h.

Function Documentation

safecomm_rr_make_saf_config()

safecomm_status_t safecomm_rr_make_saf_config	(	const safecomm_rr_config_t *	cfg,
		safecomm_saf_config_t *	out_saf )

Build a SaF config for a Subset-098 RBC/RBC connection.

Parameters

cfg	the RBC/RBC profile parameters. Non-NULL.
out_saf	receives the SaF config. Non-NULL.

Returns

SAFECOMM_STATUS_OK / _INVALID_PARAM / _NOT_IMPLEMENTED.

Note

REQ-SC-RR-003.

Definition at line 12 of file rbc_rbc.c.