libRBR  v1.2.3
RBR instrument communication API
Data Fields
RBRParserCallbacks Struct Reference

A set of callbacks from parser to user code. More...

#include <RBRParser.h>

Collaboration diagram for RBRParserCallbacks:
Collaboration graph
[legend]

Data Fields

RBRParserSampleCallback sample
 Called when a sample has been parsed. More...
 
RBRInstrumentSamplesampleBuffer
 Where to put sample data for consumption by the sample callback. More...
 
RBRParserEventCallback event
 Called when an event has been parsed. More...
 
RBRInstrumentEventeventBuffer
 Where to put event data for consumption by the event callback. More...
 

Detailed Description

A set of callbacks from parser to user code.

All of the callback functions are optional; however, where any callback function is provided, the corresponding buffer must also be provided, or else RBRParser_init() will return RBRINSTRUMENT_MISSING_CALLBACK.

Field Documentation

◆ event

RBRParserEventCallback RBRParserCallbacks::event

Called when an event has been parsed.

Requires that RBRParserCallbacks.eventBuffer also be populated.

◆ eventBuffer

RBRInstrumentEvent* RBRParserCallbacks::eventBuffer

Where to put event data for consumption by the event callback.

Required only when RBRParserCallbacks.event is populated.

◆ sample

RBRParserSampleCallback RBRParserCallbacks::sample

Called when a sample has been parsed.

Requires that RBRParserCallbacks.sampleBuffer also be populated.

◆ sampleBuffer

RBRInstrumentSample* RBRParserCallbacks::sampleBuffer

Where to put sample data for consumption by the sample callback.

Required only when RBRParserCallbacks.sample is populated.


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