AnnotatorComm::ResponseMessageQueue Class Reference

#include <ResponseMessageQueue.h>

List of all members.

Public Member Functions

 ResponseMessageQueue ()
virtual ~ResponseMessageQueue ()
void close ()
ResponseMessage get () throw (IOException)
void put (ResponseMessage &msg)


Detailed Description

The ResponseMessageQueue queues messages for retrieval.

Definition at line 29 of file ResponseMessageQueue.h.


Constructor & Destructor Documentation

AnnotatorComm::ResponseMessageQueue::ResponseMessageQueue (  ) 

Construct a ResponseMessageQueue.

virtual AnnotatorComm::ResponseMessageQueue::~ResponseMessageQueue (  )  [virtual]

ResponseMessageQueue destructor


Member Function Documentation

void AnnotatorComm::ResponseMessageQueue::close (  ) 

Close the ResponseMessageQueue.

Exceptions:
IOException failure to close

ResponseMessage AnnotatorComm::ResponseMessageQueue::get (  )  throw (IOException)

Get a message from the queue. If there are no message available, wait until one arrives. If a message does not arrive within the timeout period, an IOException is thrown.

Returns:
response message
Exceptions:
IOException failure to get a message (closed or timed out)

void AnnotatorComm::ResponseMessageQueue::put ( ResponseMessage msg  ) 

Put a message into the queue.

Parameters:
msg response message


The documentation for this class was generated from the following file:
Generated on Thu Jul 27 11:05:04 2006 for libAnnotatorComm by  doxygen 1.4.7