goby::acomms::Queue Class Reference

#include <goby/acomms/queue/queue.h>

Public Member Functions
	Queue (const google::protobuf::Descriptor *desc, QueueManager *parent, protobuf::QueuedMessageEntry cfg=protobuf::QueuedMessageEntry())
bool	push_message (const std::shared_ptr< google::protobuf::Message > &dccl_msg)
bool	push_message (const std::shared_ptr< google::protobuf::Message > &dccl_msg, protobuf::QueuedMessageMeta meta)
protobuf::QueuedMessageMeta	meta_from_msg (const google::protobuf::Message &dccl_msg)
boost::any	find_queue_field (const std::string &field_name, const google::protobuf::Message &msg)
goby::acomms::QueuedMessage	give_data (unsigned frame)
bool	pop_message (unsigned frame)
bool	pop_message_ack (unsigned frame, std::shared_ptr< google::protobuf::Message > &removed_msg)
void	stream_for_pop (const QueuedMessage &queued_msg)
std::vector< std::shared_ptr< google::protobuf::Message > >	expire ()
bool	get_priority_values (double *priority, boost::posix_time::ptime *last_send_time, const protobuf::ModemTransmission &request_msg, const std::string &data)
bool	clear_ack_queue (unsigned start_frame)
void	flush ()
size_t	size () const
boost::posix_time::ptime	last_send_time () const
boost::posix_time::ptime	newest_msg_time () const
void	info (std::ostream *os) const
std::string	name () const
void	set_cfg (const protobuf::QueuedMessageEntry &cfg)
void	process_cfg ()
const protobuf::QueuedMessageEntry &	queue_message_options ()
const google::protobuf::Descriptor *	descriptor () const
int	id ()

Detailed Description

Definition at line 73 of file queue.h.

Constructor & Destructor Documentation

Queue()

goby::acomms::Queue::Queue	(	const google::protobuf::Descriptor *	desc,
		QueueManager *	parent,
		protobuf::QueuedMessageEntry	cfg = protobuf::QueuedMessageEntry()
	)

Member Function Documentation

clear_ack_queue()

bool goby::acomms::Queue::clear_ack_queue

(

unsigned

start_frame

)

descriptor()

const google::protobuf::Descriptor * goby::acomms::Queue::descriptor ( ) const

inline

Definition at line 128 of file queue.h.

expire()

std::vector< std::shared_ptr< google::protobuf::Message > > goby::acomms::Queue::expire

(

)

find_queue_field()

boost::any goby::acomms::Queue::find_queue_field	(	const std::string &	field_name,
		const google::protobuf::Message &	msg
	)

flush()

void goby::acomms::Queue::flush

(

)

get_priority_values()

bool goby::acomms::Queue::get_priority_values	(	double *	priority,
		boost::posix_time::ptime *	last_send_time,
		const protobuf::ModemTransmission &	request_msg,
		const std::string &	data
	)

give_data()

goby::acomms::QueuedMessage goby::acomms::Queue::give_data

(

unsigned

frame

)

id()

int goby::acomms::Queue::id ( )

inline

Definition at line 130 of file queue.h.

info()

void goby::acomms::Queue::info

(

std::ostream *

os

)

const

last_send_time()

boost::posix_time::ptime goby::acomms::Queue::last_send_time ( ) const

inline

Definition at line 106 of file queue.h.

meta_from_msg()

protobuf::QueuedMessageMeta goby::acomms::Queue::meta_from_msg

(

const google::protobuf::Message &

dccl_msg

)

name()

std::string goby::acomms::Queue::name ( ) const

inline

Definition at line 117 of file queue.h.

newest_msg_time()

boost::posix_time::ptime goby::acomms::Queue::newest_msg_time ( ) const

inline

Definition at line 108 of file queue.h.

pop_message()

bool goby::acomms::Queue::pop_message

(

unsigned

frame

)

pop_message_ack()

bool goby::acomms::Queue::pop_message_ack	(	unsigned	frame,
		std::shared_ptr< google::protobuf::Message > &	removed_msg
	)

process_cfg()

void goby::acomms::Queue::process_cfg

(

)

push_message() [1/2]

bool goby::acomms::Queue::push_message

(

const std::shared_ptr< google::protobuf::Message > &

dccl_msg

)

push_message() [2/2]

bool goby::acomms::Queue::push_message	(	const std::shared_ptr< google::protobuf::Message > &	dccl_msg,
		protobuf::QueuedMessageMeta	meta
	)

queue_message_options()

const protobuf::QueuedMessageEntry & goby::acomms::Queue::queue_message_options ( )

inline

Definition at line 126 of file queue.h.

set_cfg()

void goby::acomms::Queue::set_cfg ( const protobuf::QueuedMessageEntry &  cfg )

inline

Definition at line 119 of file queue.h.

size()

size_t goby::acomms::Queue::size ( ) const

inline

Definition at line 104 of file queue.h.

stream_for_pop()

void goby::acomms::Queue::stream_for_pop

(

const QueuedMessage &

queued_msg

)

---

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

• goby/acomms/queue/queue.h