AsyncResultI (ice 3.6.5 API)

java.lang.Object
- IceInternal.AsyncResultI

All Implemented Interfaces:

AsyncResult

Direct Known Subclasses:

CommunicatorFlushBatch, OutgoingAsyncBase
```
public class AsyncResultI
extends java.lang.Object
implements AsyncResult
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected Connection`	`_cachedConnection`
`protected Instance`	`_instance`
`protected InvocationObserver`	`_observer`
`protected boolean`	`_sentSynchronously`
`protected byte`	`_state`
`protected static byte`	`StateCachedBuffers`
`protected static byte`	`StateDone`
`protected static byte`	`StateEndCalled`
`protected static byte`	`StateOK`
`protected static byte`	`StateSent`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AsyncResultI(Communicator communicator, Instance instance, java.lang.String op, CallbackBase del)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`__wait()`
`void`	`cacheMessageBuffers()`
`void`	`cancel()` If not completed, cancels the request.
`protected void`	`cancel(LocalException ex)`
`void`	`cancelable(CancellationHandler handler)`
`protected static void`	`check(AsyncResult r, java.lang.String operation)`
`protected boolean`	`finished(boolean ok)`
`protected boolean`	`finished(Exception ex)`
`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`).
`protected InvocationObserver`	`getObserver()`
`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.
`void`	`invokeCompleted()`
`void`	`invokeCompletedAsync()`
`void`	`invokeSent()`
`protected void`	`invokeSentAsync()`
`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.
`protected boolean`	`sent(boolean done)`
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _instance
```
protected final Instance _instance
```
  - _observer
```
protected InvocationObserver _observer
```
  - _cachedConnection
```
protected Connection _cachedConnection
```
  - _sentSynchronously
```
protected boolean _sentSynchronously
```
  - StateOK
```
protected static final byte StateOK
```
    See Also:
    
    Constant Field Values
  - StateDone
```
protected static final byte StateDone
```
    See Also:
    
    Constant Field Values
  - StateSent
```
protected static final byte StateSent
```
    See Also:
    
    Constant Field Values
  - StateEndCalled
```
protected static final byte StateEndCalled
```
    See Also:
    
    Constant Field Values
  - StateCachedBuffers
```
protected static final byte StateCachedBuffers
```
    See Also:
    
    Constant Field Values
  - _state
```
protected byte _state
```
- Constructor Detail
  - AsyncResultI
```
protected AsyncResultI(Communicator communicator,
                       Instance instance,
                       java.lang.String op,
                       CallbackBase del)
```
- Method Detail
  - cancel
```
public void cancel()
```
    Description copied from interface: AsyncResult
    
    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.
    
    Specified by:
    
    cancel in interface AsyncResult
  - getCommunicator
```
public Communicator getCommunicator()
```
    Description copied from interface: AsyncResult
    
    Returns the communicator that sent the invocation.
    
    Specified by:
    
    getCommunicator in interface AsyncResult
    
    Returns:
    
    The communicator.
  - getConnection
```
public Connection getConnection()
```
    Description copied from interface: AsyncResult
    
    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).
    
    Specified by:
    
    getConnection in interface AsyncResult
    
    Returns:
    
    The connection.
  - getProxy
```
public ObjectPrx getProxy()
```
    Description copied from interface: AsyncResult
    
    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.
    
    Specified by:
    
    getProxy in interface AsyncResult
    
    Returns:
    
    The proxy.
  - isCompleted
```
public final boolean isCompleted()
```
    Description copied from interface: AsyncResult
    
    Indicates whether the result of an invocation is available.
    
    Specified by:
    
    isCompleted in interface AsyncResult
    
    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
```
public final void waitForCompleted()
```
    Description copied from interface: AsyncResult
    
    Blocks the caller until the result of the invocation is available.
    
    Specified by:
    
    waitForCompleted in interface AsyncResult
  - isSent
```
public final boolean isSent()
```
    Description copied from interface: AsyncResult
    
    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.
    
    Specified by:
    
    isSent in interface AsyncResult
    
    Returns:
    
    True if the request has been sent, or false if the request is queued.
  - waitForSent
```
public final void waitForSent()
```
    Description copied from interface: AsyncResult
    
    Blocks the caller until the request has been written to the client-side transport.
    
    Specified by:
    
    waitForSent in interface AsyncResult
  - throwLocalException
```
public final void throwLocalException()
```
    Description copied from interface: AsyncResult
    
    If the invocation failed with a local exception, throws the local exception.
    
    Specified by:
    
    throwLocalException in interface AsyncResult
  - sentSynchronously
```
public final boolean sentSynchronously()
```
    Description copied from interface: AsyncResult
    
    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).
    
    Specified by:
    
    sentSynchronously in interface AsyncResult
    
    Returns:
    
    True if the request was sent without being queued, or false otherwise.
  - getOperation
```
public final java.lang.String getOperation()
```
    Description copied from interface: AsyncResult
    
    Returns the name of the operation.
    
    Specified by:
    
    getOperation in interface AsyncResult
    
    Returns:
    
    The operation name.
  - invokeSent
```
public final void invokeSent()
```
  - invokeCompleted
```
public final void invokeCompleted()
```
  - invokeCompletedAsync
```
public final void invokeCompletedAsync()
```
  - cancelable
```
public void cancelable(CancellationHandler handler)
```
  - __wait
```
public final boolean __wait()
```
  - cacheMessageBuffers
```
public void cacheMessageBuffers()
```
  - sent
```
protected boolean sent(boolean done)
```
  - finished
```
protected boolean finished(boolean ok)
```
  - finished
```
protected boolean finished(Exception ex)
```
  - invokeSentAsync
```
protected final void invokeSentAsync()
```
  - cancel
```
protected void cancel(LocalException ex)
```
  - getObserver
```
protected InvocationObserver getObserver()
```
  - check
```
protected static void check(AsyncResult r,
                            java.lang.String operation)
```

Class AsyncResultI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_instance

_observer

_cachedConnection

_sentSynchronously

StateOK

StateDone

StateSent

StateEndCalled

StateCachedBuffers

_state

Constructor Detail

AsyncResultI

Method Detail

cancel

getCommunicator

getConnection

getProxy

isCompleted

waitForCompleted

isSent

waitForSent

throwLocalException

sentSynchronously

getOperation

invokeSent

invokeCompleted

invokeCompletedAsync

cancelable

__wait

cacheMessageBuffers

sent

finished

finished

invokeSentAsync

cancel

getObserver

check