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

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

#include <service.h>

Data Fields

const char * p_nameProducer
spp_uint16_t tiemoutMs
SPP_RetVal_t(*) init ()
SPP_RetVal_t(*) acquireData ()

Detailed Description

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

  • a producer ID
  • a name
  • a timeout
  • an init function
  • an acquireData function

Definition at line 27 of file service.h.

Field Documentation

◆ p_nameProducer

const char* SPP_SERVICE_ProducerContract_t::p_nameProducer

Human-readable module name (for logging).

Definition at line 29 of file service.h.

◆ tiemoutMs

spp_uint16_t SPP_SERVICE_ProducerContract_t::tiemoutMs

Timeout for the producer to send a packet

Definition at line 30 of file service.h.

◆ init

SPP_RetVal_t(*) SPP_SERVICE_ProducerContract_t::init()

Initialise the module.

Definition at line 31 of file service.h.

Referenced by SPP_SERVICES_PUBSUB_init().

◆ acquireData

SPP_RetVal_t(*) SPP_SERVICE_ProducerContract_t::acquireData()

Acquire data from the module.

Definition at line 32 of file service.h.

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