sensesp::SKDeltaQueue Class Reference

Signal K delta queue. More...

#include <sensesp/signalk/signalk_delta_queue.h>

Inheritance diagram for sensesp::SKDeltaQueue:

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 ()
virtual void	start () override
bool	take_semaphore (unsigned long int timeout_ms=0)
void	release_semaphore ()
Public Member Functions inherited from sensesp::Startable
	Startable (int priority=0)
const int	get_start_priority ()
void	set_start_priority (int priority)

Additional Inherited Members
Static Public Member Functions inherited from sensesp::Startable
static void	start_all ()

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 (WSClient, NMEA 2000 messages, carrier pigeons).

Definition at line 19 of file signalk_delta_queue.h.

Constructor & Destructor Documentation

SKDeltaQueue()

sensesp::SKDeltaQueue::SKDeltaQueue

(

unsigned int

max_buffer_size = 20

)

Definition at line 11 of file signalk_delta_queue.cpp.

Member Function Documentation

append()

void sensesp::SKDeltaQueue::append

(

const String

val

)

Definition at line 28 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 37 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 46 of file signalk_delta_queue.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

get_delta()

void sensesp::SKDeltaQueue::get_delta

(

String &

output

)

Definition at line 99 of file signalk_delta_queue.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

release_semaphore()

void sensesp::SKDeltaQueue::release_semaphore

(

)

Definition at line 26 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 30 of file signalk_delta_queue.h.

Here is the call graph for this function:

Here is the caller graph for this function:

start()

void sensesp::SKDeltaQueue::start ( )

overridevirtual

Called during the initialization process. Override this method to add runtime initialization code to your class

Reimplemented from sensesp::Startable.

Definition at line 16 of file signalk_delta_queue.cpp.

Here is the call graph for this function:

take_semaphore()

bool sensesp::SKDeltaQueue::take_semaphore

(

unsigned long int

timeout_ms = 0

)

Definition at line 18 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:

• src/sensesp/signalk/signalk_delta_queue.h
• src/sensesp/signalk/signalk_delta_queue.cpp