CARMA C++
sza::util::PipeQ< Msg > Class Template Reference

Template class for a message queue implemented using pipes. More...

#include <carma/szautil/PipeQ.h>

Public Member Functions

int fd ()
 Return the selectable file descriptor associated with this message queue. More...
 
 PipeQ ()
 Constructor. More...
 
void readMsg (Msg *msg)
 Read message method simply gets the next message off the pipe. More...
 
fd_set rfds ()
 Return an intialized set of readable file descriptors associated with this queue. More...
 
void sendMsg (Msg *msg)
 Method to send a message to the message queue. More...
 
 ~PipeQ ()
 Destructor. More...
 

Detailed Description

template<class Msg>
class sza::util::PipeQ< Msg >

Template class for a message queue implemented using pipes.

Definition at line 20 of file PipeQ.h.

Constructor & Destructor Documentation

template<class Msg >
sza::util::PipeQ< Msg >::PipeQ ( )

Constructor.

Constructor function.

Exceptions
Exception(via Pipe::Pipe)

Definition at line 114 of file PipeQ.h.

template<class Msg >
sza::util::PipeQ< Msg >::~PipeQ ( )

Destructor.

Destructor function.

Exceptions
Exception(via Pipe::~Pipe)

Definition at line 122 of file PipeQ.h.

Member Function Documentation

template<class Msg >
int sza::util::PipeQ< Msg >::fd ( )

Return the selectable file descriptor associated with this message queue.

Get the readable file descriptor associated with this queue.

Definition at line 94 of file PipeQ.h.

template<class Msg>
void sza::util::PipeQ< Msg >::readMsg ( Msg *  msg)

Read message method simply gets the next message off the pipe.

Read the next message off the pipe.

Exceptions
Exception

Definition at line 85 of file PipeQ.h.

template<class Msg >
fd_set sza::util::PipeQ< Msg >::rfds ( )

Return an intialized set of readable file descriptors associated with this queue.

Get the readable file descriptor associated with this queue.

Definition at line 103 of file PipeQ.h.

template<class Msg>
void sza::util::PipeQ< Msg >::sendMsg ( Msg *  msg)

Method to send a message to the message queue.

Write the next message to the pipe.

Exceptions
Exception

Definition at line 74 of file PipeQ.h.


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