Instrument Neutral Distributed Interface INDI 2.2.5
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
MsgQueue Class Referenceabstract

#include <MsgQueue.hpp>

Inheritance diagram for MsgQueue:
Collectable ClInfo DvrInfo LocalDvrInfo RemoteDvrInfo

Public Member Functions

virtual ~MsgQueue ()
 
void pushMsg (Msg *msg)
 
unsigned long msgQSize () const
 
SerializedMsg * headMsg () const
 
void consumeHeadMsg ()
 
void clearMsgQueue ()
 
void messageMayHaveProgressed (const SerializedMsg *msg)
 
void setFds (int rFd, int wFd)
 
virtual bool acceptSharedBuffers () const
 
virtual void log (const std::string &log) const
 

Protected Member Functions

int getRFd () const
 
int getWFd () const
 
void traceMsg (const std::string &log, XMLEle *root)
 
virtual void close ()=0
 
virtual void closeWritePart ()
 
virtual void onMessage (XMLEle *root, std::list< int > &sharedBuffers)=0
 
 MsgQueue (bool useSharedBuffer)
 
- Protected Member Functions inherited from Collectable
HeartBeat heartBeat () const
 

Static Protected Member Functions

static void crackBLOB (const char *enableBLOB, BLOBHandling *bp)
 

Protected Attributes

bool useSharedBuffer
 

Detailed Description

Definition at line 33 of file MsgQueue.hpp.

Constructor & Destructor Documentation

◆ MsgQueue()

MsgQueue::MsgQueue ( bool  useSharedBuffer)
protected

Definition at line 220 of file MsgQueue.cpp.

◆ ~MsgQueue()

MsgQueue::~MsgQueue ( )
virtual

Definition at line 229 of file MsgQueue.cpp.

Member Function Documentation

◆ acceptSharedBuffers()

virtual bool MsgQueue::acceptSharedBuffers ( ) const
inlinevirtual

Reimplemented in DvrInfo.

Definition at line 112 of file MsgQueue.hpp.

◆ clearMsgQueue()

void MsgQueue::clearMsgQueue ( )

Definition at line 380 of file MsgQueue.cpp.

◆ close()

virtual void MsgQueue::close ( )
protectedpure virtual

Implemented in ClInfo, and DvrInfo.

◆ closeWritePart()

void MsgQueue::closeWritePart ( )
protectedvirtual

Reimplemented in DvrInfo.

Definition at line 249 of file MsgQueue.cpp.

◆ consumeHeadMsg()

void MsgQueue::consumeHeadMsg ( )

Definition at line 326 of file MsgQueue.cpp.

◆ crackBLOB()

void MsgQueue::crackBLOB ( const char *  enableBLOB,
BLOBHandling *  bp 
)
staticprotected

Definition at line 174 of file MsgQueue.cpp.

◆ getRFd()

int MsgQueue::getRFd ( ) const
inlineprotected

Definition at line 67 of file MsgQueue.hpp.

◆ getWFd()

int MsgQueue::getWFd ( ) const
inlineprotected

Definition at line 71 of file MsgQueue.hpp.

◆ headMsg()

SerializedMsg * MsgQueue::headMsg ( ) const

Definition at line 320 of file MsgQueue.cpp.

◆ log()

void MsgQueue::log ( const std::string &  log) const
virtual

Reimplemented in ClInfo, and DvrInfo.

Definition at line 163 of file MsgQueue.cpp.

◆ messageMayHaveProgressed()

void MsgQueue::messageMayHaveProgressed ( const SerializedMsg *  msg)

Definition at line 372 of file MsgQueue.cpp.

◆ msgQSize()

unsigned long MsgQueue::msgQSize ( ) const

Definition at line 396 of file MsgQueue.cpp.

◆ onMessage()

virtual void MsgQueue::onMessage ( XMLEle *  root,
std::list< int > &  sharedBuffers 
)
protectedpure virtual

Implemented in ClInfo, and DvrInfo.

◆ pushMsg()

void MsgQueue::pushMsg ( Msg *  msg)

Definition at line 336 of file MsgQueue.cpp.

◆ setFds()

void MsgQueue::setFds ( int  rFd,
int  wFd 
)

Definition at line 284 of file MsgQueue.cpp.

◆ traceMsg()

void MsgQueue::traceMsg ( const std::string &  log,
XMLEle *  root 
)
protected

Definition at line 186 of file MsgQueue.cpp.

Member Data Documentation

◆ useSharedBuffer

bool MsgQueue::useSharedBuffer
protected

Definition at line 66 of file MsgQueue.hpp.


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