Solaris Software
Loading...
Searching...
No Matches
SPP_SERVICE_ConsumerContract_t Struct Reference

Describes the contract of a consumer module. This module needs to have: More...

#include <service.h>

Data Fields

spp_int8_t priority
const char * p_nameConsumer
spp_uint16_t tiemoutMs
spp_uint16_t suscribeToApid
SPP_RetVal_t(*) init ()
SPP_RetVal_t(*) deliverToMailbox (const SPP_Packet_t packet)
SPP_RetVal_t(*) consumeData (void *p_data)

Detailed Description

Describes the contract of a consumer module. This module needs to have:

  • a consumer ID
  • a name
  • a timeout (optional)
  • a consumeData function

Definition at line 42 of file service.h.

Field Documentation

◆ priority

spp_int8_t SPP_SERVICE_ConsumerContract_t::priority

Priority of the consumer

Definition at line 44 of file service.h.

Referenced by SPP_SERVICES_PUBSUB_sortConsumers().

◆ p_nameConsumer

const char* SPP_SERVICE_ConsumerContract_t::p_nameConsumer

Human-readable module name (for logging).

Definition at line 45 of file service.h.

◆ tiemoutMs

spp_uint16_t SPP_SERVICE_ConsumerContract_t::tiemoutMs

Timeout for the consumer to receive a packet

Definition at line 46 of file service.h.

◆ suscribeToApid

spp_uint16_t SPP_SERVICE_ConsumerContract_t::suscribeToApid

APID subscription bitmask

Definition at line 47 of file service.h.

◆ init

SPP_RetVal_t(*) SPP_SERVICE_ConsumerContract_t::init()

Initialise the module.

Definition at line 48 of file service.h.

Referenced by SPP_SERVICES_PUBSUB_init().

◆ deliverToMailbox

SPP_RetVal_t(*) SPP_SERVICE_ConsumerContract_t::deliverToMailbox(const SPP_Packet_t packet)

Definition at line 49 of file service.h.

◆ consumeData

SPP_RetVal_t(*) SPP_SERVICE_ConsumerContract_t::consumeData(void *p_data)

Consume data from the module.

Definition at line 50 of file service.h.

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