SensESP 3.0.1
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::SKDeltaQueue Class Reference

Signal K delta queue. More...

#include <sensesp/signalk/signalk_delta_queue.h>

Public Member Functions

 SKDeltaQueue (unsigned int max_buffer_size=20)
 
void append (const String &val)
 
bool data_available ()
 
void get_delta (String &output)
 
void connect_emitters ()
 
void reset_meta_send ()
 
bool take_semaphore (uint64_t timeout_ms=0)
 
void release_semaphore ()
 

Detailed Description

Signal K delta queue.

This class implements a Signal K delta queue. There should be a unique queue for each possible output channel (SKWSClient, NMEA 2000 messages, carrier pigeons).

Definition at line 16 of file signalk_delta_queue.h.

Constructor & Destructor Documentation

◆ SKDeltaQueue()

sensesp::SKDeltaQueue::SKDeltaQueue ( unsigned int max_buffer_size = 20)

Definition at line 12 of file signalk_delta_queue.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ append()

void sensesp::SKDeltaQueue::append ( const String & val)

Definition at line 30 of file signalk_delta_queue.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ connect_emitters()

void sensesp::SKDeltaQueue::connect_emitters ( )

Definition at line 39 of file signalk_delta_queue.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ data_available()

bool sensesp::SKDeltaQueue::data_available ( )

Definition at line 53 of file signalk_delta_queue.cpp.

Here is the call graph for this function:

◆ get_delta()

void sensesp::SKDeltaQueue::get_delta ( String & output)

Definition at line 60 of file signalk_delta_queue.cpp.

Here is the call graph for this function:

◆ release_semaphore()

void sensesp::SKDeltaQueue::release_semaphore ( )

Definition at line 28 of file signalk_delta_queue.cpp.

Here is the caller graph for this function:

◆ reset_meta_send()

void sensesp::SKDeltaQueue::reset_meta_send ( )
inline

Used to indicate that the next update generated by this delta should have metadata added to it.

Definition at line 27 of file signalk_delta_queue.h.

Here is the call graph for this function:

◆ take_semaphore()

bool sensesp::SKDeltaQueue::take_semaphore ( uint64_t timeout_ms = 0)

Definition at line 20 of file signalk_delta_queue.cpp.

Here is the caller graph for this function:

The documentation for this class was generated from the following files: