Configuration for sapi_channel_init(). More...

#include <sapi_channel.h>

Data Fields
void *	channel_handle
sapi_channel_send_fn	send
sapi_channel_recv_fn	recv
const char *	name

Detailed Description

Configuration for sapi_channel_init().

Definition at line 90 of file sapi_channel.h.

Field Documentation

◆ channel_handle

void* sapi_channel_config_t::channel_handle

Opaque transport handle, passed verbatim to send/recv below. Caller-owned; this module never dereferences it. May be NULL if the send/recv callbacks don't need it.

Definition at line 94 of file sapi_channel.h.

◆ send

sapi_channel_send_fn sapi_channel_config_t::send

Backend send function. Must not be NULL.

Definition at line 96 of file sapi_channel.h.

◆ recv

sapi_channel_recv_fn sapi_channel_config_t::recv

Backend receive function. Must not be NULL.

Definition at line 98 of file sapi_channel.h.

◆ name

const char* sapi_channel_config_t::name

Optional channel name (e.g. "ChannelAtoB"), for lookup (sapi_voter_get_channel_by_name()) and logging - same caller-owned-pointer convention as sapi_watchdog_config_t::name: not copied, so it must outlive this channel (a string literal is the common case). May be NULL, in which case this channel is never matched by sapi_voter_get_channel_by_name().

Definition at line 105 of file sapi_channel.h.

The documentation for this struct was generated from the following file:

include/safeapi/redundancy/channel_link/sapi_channel.h