ab_gp_status.h File Reference

ADR-038: this A/B channel's periodic status - a self log line plus a PUBLISH(STATUS) rbc_util_frame_t out on the UTIL relay to the role-C status/broker service. More...

#include <stdint.h>
#include "ab_gp_channel.h"
#include "ab_gp_channel_types.h"

Include dependency graph for ab_gp_status.h:

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

Go to the source code of this file.

Functions
void	ab_gp_status_tick (ab_gp_channel_handle_t handle, const ab_gp_channel_context_t *ctx, uint32_t cycle)
	Call once per cyclic-executive cycle from post_execute. Emits a status self line and publishes a STATUS frame on the UTIL relay every RTE_EXAMPLE_STATUS_PERIOD_MS (and on the first cycle).

Detailed Description

ADR-038: this A/B channel's periodic status - a self log line plus a PUBLISH(STATUS) rbc_util_frame_t out on the UTIL relay to the role-C status/broker service.

Non-safety (ADR-001 4): it only reads state and sends one non-vital monitoring frame; it can never influence a decision or a checkpoint.

Definition in file ab_gp_status.h.

Function Documentation

ab_gp_status_tick()

void ab_gp_status_tick	(	ab_gp_channel_handle_t	handle,
		const ab_gp_channel_context_t *	ctx,
		uint32_t	cycle )

Call once per cyclic-executive cycle from post_execute. Emits a status self line and publishes a STATUS frame on the UTIL relay every RTE_EXAMPLE_STATUS_PERIOD_MS (and on the first cycle).

Parameters

handle	This channel's handle (for ab_gp_channel_send_relay).
ctx	This channel's context (state to report). Must not be NULL.
cycle	ctx->cyc_cycle.

Definition at line 39 of file ab_gp_status.c.