Represents the result of an asynchronous invocation using the C++98 mapping.
More...
#include <Ice/Ice.h>
|
| virtual void | cancel ()=0 |
| | Prevents a queued invocation from being sent or, if the invocation has already been sent, ignores a reply if the server sends one.
|
| virtual CommunicatorPtr | getCommunicator () const =0 |
| | Obtains the communicator that sent the invocation.
|
| virtual ConnectionPtr | getConnection () const =0 |
| | Obtains the connection that was used for the invocation.
|
| virtual LocalObjectPtr | getCookie () const =0 |
| | Obtains the cookie that was passed to the begin_ method.
|
| virtual Int | getHash () const =0 |
| | Allows you to create ordered or hashed collections of pending asynchronous invocations.
|
| virtual const std::string & | getOperation () const =0 |
| | Obtains the name of the operation.
|
| virtual ObjectPrxPtr | getProxy () const =0 |
| | Obtains the proxy that was used to call the begin_ method, or nil if the AsyncResult object was not obtained via an asynchronous proxy invocation.
|
| virtual bool | isCompleted () const =0 |
| | Obtains the completion status of the invocation.
|
| virtual bool | isSent () const =0 |
| | Obtains the sent status of the invocation.
|
| virtual bool | sentSynchronously () const =0 |
| | Determines whether the request was sent synchronously.
|
| virtual void | throwLocalException () const =0 |
| | Throws the local exception that caused the invocation to fail.
|
| virtual void | waitForCompleted ()=0 |
| | Blocks the caller until the result of an invocation becomes available.
|
| virtual void | waitForSent ()=0 |
| | Blocks the calling thread until a request has been written to the client-side transport, or an exception occurs.
|
| virtual | ~AsyncResult () |
| virtual bool | operator< (const LocalObject &) const |
| virtual bool | operator== (const LocalObject &) const |
| void | __clearFlag (unsigned char flag) |
| virtual void | __decRef () |
| virtual int | __getRef () const |
| bool | __hasFlag (unsigned char flag) |
| virtual void | __incRef () |
| void | __setFlag (unsigned char flag) |
| virtual void | __setNoDelete (bool) |
| Shared & | operator= (const Shared &) |
| | Shared () |
| | Shared (const Shared &) |
| virtual | ~Shared () |
Represents the result of an asynchronous invocation using the C++98 mapping.
◆ ~AsyncResult()
| virtual Ice::AsyncResult::~AsyncResult |
( |
| ) |
|
|
virtual |
◆ cancel()
| virtual void Ice::AsyncResult::cancel |
( |
| ) |
|
|
pure virtual |
Prevents a queued invocation from being sent or, if the invocation has already been sent, ignores a reply if the server sends one.
cancel is a local operation and has no effect on the server. A canceled invocation is considered to be completed, meaning isCompleted returns true, and the result of the invocation is an InvocationCanceledException.
◆ getCommunicator()
Obtains the communicator that sent the invocation.
- Returns
- A reference to the communicator.
◆ getConnection()
Obtains the connection that was used for the invocation.
Note that, for typical asynchronous proxy invocations, this method returns a nil value because the possibility of automatic retries means the connection that is currently in use could change unexpectedly. The getConnection method only returns a non-nil value when the AsyncResult object is obtained by calling Connection::begin_flushBatchRequests.
- Returns
- A reference to the connection.
◆ getCookie()
Obtains the cookie that was passed to the begin_ method.
- Returns
- The cookie, or nil if you did not pass a cookie to the begin_ method.
◆ getHash()
| virtual Int Ice::AsyncResult::getHash |
( |
| ) |
const |
|
pure virtual |
Allows you to create ordered or hashed collections of pending asynchronous invocations.
- Returns
- A unique hash code for this object.
◆ getOperation()
| virtual const std::string & Ice::AsyncResult::getOperation |
( |
| ) |
const |
|
pure virtual |
Obtains the name of the operation.
- Returns
- The operation name.
◆ getProxy()
Obtains the proxy that was used to call the begin_ method, or nil if the AsyncResult object was not obtained via an asynchronous proxy invocation.
- Returns
- A reference to the proxy.
◆ isCompleted()
| virtual bool Ice::AsyncResult::isCompleted |
( |
| ) |
const |
|
pure virtual |
Obtains the completion status of the invocation.
- Returns
- True if, at the time it is called, the result of an invocation is available, indicating that a call to the end_ method will not block the caller. Otherwise, if the result is not yet available, the method returns false.
◆ isSent()
| virtual bool Ice::AsyncResult::isSent |
( |
| ) |
const |
|
pure virtual |
Obtains the sent status of the invocation.
- Returns
- True if, at the time it is called, the request has been written to the local transport (whether it was initially queued or not). Otherwise, if the request is still queued or an exception occurred before the request could be sent, this method returns false.
◆ sentSynchronously()
| virtual bool Ice::AsyncResult::sentSynchronously |
( |
| ) |
const |
|
pure virtual |
Determines whether the request was sent synchronously.
- Returns
- True if a request was written to the client-side transport without first being queued. If the request was initially queued, sentSynchronously returns false (independent of whether the request is still in the queue or has since been written to the client-side transport).
◆ throwLocalException()
| virtual void Ice::AsyncResult::throwLocalException |
( |
| ) |
const |
|
pure virtual |
Throws the local exception that caused the invocation to fail.
If no exception has occurred yet, this method does nothing.
◆ waitForCompleted()
| virtual void Ice::AsyncResult::waitForCompleted |
( |
| ) |
|
|
pure virtual |
Blocks the caller until the result of an invocation becomes available.
◆ waitForSent()
| virtual void Ice::AsyncResult::waitForSent |
( |
| ) |
|
|
pure virtual |
Blocks the calling thread until a request has been written to the client-side transport, or an exception occurs.
The documentation for this class was generated from the following file:
1.16.0