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

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

#include <RBRInstrument.h>

Collaboration diagram for RBRInstrumentCallbacks:
Collaboration graph
[legend]

Data Fields

RBRInstrumentTimeCallback time
 Callback to get the current platform time in milliseconds.
 
RBRInstrumentSleepCallback sleep
 Callback to suspend activity for a fixed amount of time.
 
RBRInstrumentReadCallback read
 Called to read data from the physical instrument.
 
RBRInstrumentWriteCallback write
 Called to write data to the physical instrument.
 
RBRInstrumentSampleCallback sample
 Called when streaming sample data has been received. More...
 
struct RBRInstrumentSamplesampleBuffer
 Where to put sample data for consumption by the sample callback. More...
 

Detailed Description

A set of callbacks from library to user code.

RBRInstrument_open() requires all callbacks to be populated except for RBRInstrumentCallbacks.sample, which may be NULL when undesired.

Field Documentation

◆ sample

RBRInstrumentSampleCallback RBRInstrumentCallbacks::sample

Called when streaming sample data has been received.

Optional, but requires that RBRInstrumentCallbacks.sampleBuffer also be populated.

◆ sampleBuffer

struct RBRInstrumentSample* RBRInstrumentCallbacks::sampleBuffer

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

Required only when RBRInstrumentCallbacks.sample is populated.


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