AsyncResult (ice 3.6.5 API)

All Known Implementing Classes:

AsyncResultI, CommunicatorFlushBatch, ConnectionFlushBatch, OutgoingAsync, OutgoingAsyncBase, ProxyFlushBatch, ProxyGetConnection, ProxyOutgoingAsyncBase
```
public interface AsyncResult
```
An AsyncResult object is the return value of an asynchronous invocation. With this object, an application can obtain several attributes of the invocation and discover its outcome.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`cancel()` If not completed, cancels the request.
`Communicator`	`getCommunicator()` Returns the communicator that sent the invocation.
`Connection`	`getConnection()` Returns the connection that was used to call the `begin_` method, or nil if this AsyncResult object was not obtained via an asynchronous connection invocation (such as `begin_flushBatchRequests`).
`java.lang.String`	`getOperation()` Returns the name of the operation.
`ObjectPrx`	`getProxy()` Returns the proxy that was used to call the `begin_` method, or nil if this AsyncResult object was not obtained via an asynchronous proxy invocation.
`boolean`	`isCompleted()` Indicates whether the result of an invocation is available.
`boolean`	`isSent()` When you call the `begin_` method, the Ice run time attempts to write the corresponding request to the client-side transport.
`boolean`	`sentSynchronously()` This method returns true if a request was written to the client-side transport without first being queued.
`void`	`throwLocalException()` If the invocation failed with a local exception, throws the local exception.
`void`	`waitForCompleted()` Blocks the caller until the result of the invocation is available.
`void`	`waitForSent()` Blocks the caller until the request has been written to the client-side transport.

- Method Detail
  - cancel
```
void cancel()
```
    If not completed, cancels the request. This is a local operation, it won't cancel the request on the server side. Calling cancel prevents a queued request from being sent or ignores a reply if the request has already been sent.
  - getCommunicator
```
Communicator getCommunicator()
```
    Returns the communicator that sent the invocation.
    
    Returns:
    
    The communicator.
  - getConnection
```
Connection getConnection()
```
    Returns the connection that was used to call the begin_ method, or nil if this AsyncResult object was not obtained via an asynchronous connection invocation (such as begin_flushBatchRequests).
    
    Returns:
    
    The connection.
  - getProxy
```
ObjectPrx getProxy()
```
    Returns the proxy that was used to call the begin_ method, or nil if this AsyncResult object was not obtained via an asynchronous proxy invocation.
    
    Returns:
    
    The proxy.
  - isCompleted
```
boolean isCompleted()
```
    Indicates whether the result of an invocation is available.
    
    Returns:
    
    True if the result is available, which means a call to the end_ method will not block. The method returns false if the result is not yet available.
  - waitForCompleted
```
void waitForCompleted()
```
    Blocks the caller until the result of the invocation is available.
  - isSent
```
boolean isSent()
```
    When you call the begin_ method, the Ice run time attempts to write the corresponding request to the client-side transport. If the transport cannot accept the request, the Ice run time queues the request for later transmission. This method 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, this method returns false.
    
    Returns:
    
    True if the request has been sent, or false if the request is queued.
  - waitForSent
```
void waitForSent()
```
    Blocks the caller until the request has been written to the client-side transport.
  - throwLocalException
```
void throwLocalException()
```
    If the invocation failed with a local exception, throws the local exception.
  - sentSynchronously
```
boolean sentSynchronously()
```
    This method returns true if a request was written to the client-side transport without first being queued. If the request was initially queued, this method returns false (independent of whether the request is still in the queue or has since been written to the client-side transport).
    
    Returns:
    
    True if the request was sent without being queued, or false otherwise.
  - getOperation
```
java.lang.String getOperation()
```
    Returns the name of the operation.
    
    Returns:
    
    The operation name.

Interface AsyncResult

Method Summary

Method Detail

cancel

getCommunicator

getConnection

getProxy

isCompleted

waitForCompleted

isSent

waitForSent

throwLocalException

sentSynchronously

getOperation