activemq::transport::FutureResponse Class Reference

A container that holds a response object. More...

#include <src/main/activemq/transport/FutureResponse.h>

Public Member Functions

 FutureResponse ()
 FutureResponse (const Pointer< ResponseCallback > responseCallback)
virtual ~FutureResponse ()
Pointer< ResponsegetResponse () const
 Getters for the response property.
Pointer< ResponsegetResponse ()
Pointer< ResponsegetResponse (unsigned int timeout) const
 Getters for the response property.
Pointer< ResponsegetResponse (unsigned int timeout)
void setResponse (Pointer< Response > response)
 Setter for the response property.

Detailed Description

A container that holds a response object.

Callers of the getResponse method will block until a response has been receive unless they call the getRepsonse that takes a timeout.


Constructor & Destructor Documentation

activemq::transport::FutureResponse::FutureResponse (  ) 
activemq::transport::FutureResponse::FutureResponse ( const Pointer< ResponseCallback responseCallback  ) 
virtual activemq::transport::FutureResponse::~FutureResponse (  )  [virtual]

Member Function Documentation

Pointer<Response> activemq::transport::FutureResponse::getResponse ( unsigned int  timeout  ) 
Pointer<Response> activemq::transport::FutureResponse::getResponse ( unsigned int  timeout  )  const

Getters for the response property.

Timed Wait.

Parameters:
timeout Time to wait in milliseconds for a Response.
Returns:
the response object for the request
Exceptions:
InterruptedIOException if the wait for response is interrupted.
Pointer<Response> activemq::transport::FutureResponse::getResponse (  ) 
Pointer<Response> activemq::transport::FutureResponse::getResponse (  )  const

Getters for the response property.

Infinite Wait.

Returns:
the response object for the request.
Exceptions:
InterruptedIOException if the wait for response is interrupted.
void activemq::transport::FutureResponse::setResponse ( Pointer< Response response  ) 

Setter for the response property.

Parameters:
response the response object for the request.

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

Generated on 1 Dec 2014 for activemq-cpp-3.8.2 by  doxygen 1.6.1