AsyncRpcResult (Apache Dubbo 2.7.14 API)

java.lang.Object
- org.apache.dubbo.rpc.AsyncRpcResult

所有已实现的接口:

Serializable, Result
```
public class AsyncRpcResult
extends Object
implements Result
```
This class represents an unfinished RPC call, it will hold some context information for this call, for example RpcContext and Invocation, so that when the call finishes and the result returns, it can guarantee all the contexts being recovered as the same as when the call was made before any callback is invoked.
TODO if it's reasonable or even right to keep a reference to Invocation?
As Result implements CompletionStage, AsyncRpcResult allows you to easily build a async filter chain whose status will be driven entirely by the state of the underlying RPC call.
AsyncRpcResult does not contain any concrete value (except the underlying value bring by CompletableFuture), consider it as a status transfer node. getValue() and getException() are all inherited from Result interface, implementing them are mainly for compatibility consideration. Because many legacy Filter implementation are most possibly to call getValue directly.

另请参阅:

序列化表格

构造器概要

构造器
构造器和说明

AsyncRpcResult(CompletableFuture<AppResponse> future, Invocation invocation)

构造器
构造器和说明
`AsyncRpcResult(CompletableFuture<AppResponse> future, Invocation invocation)`

方法概要

所有方法静态方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addAttachments(Map<String,String> map)` 已过时。
`void`	`addObjectAttachments(Map<String,Object> map)` Add the specified map to existing attachments in this instance.
`Result`	`get()` This method will always return after a maximum 'timeout' waiting: 1. if value returns before timeout, return normally. 2. if no value returns after timeout, throw TimeoutException.
`Result`	`get(long timeout, TimeUnit unit)`
`Result`	`getAppResponse()`
`String`	`getAttachment(String key)` get attachment by key.
`String`	`getAttachment(String key, String defaultValue)` get attachment by key with default value.
`Map<String,String>`	`getAttachments()` 已过时。
`Throwable`	`getException()` Get exception.
`Executor`	`getExecutor()`
`Object`	`getObjectAttachment(String key)` get attachment by key.
`Object`	`getObjectAttachment(String key, Object defaultValue)` get attachment by key with default value.
`Map<String,Object>`	`getObjectAttachments()` get attachments.
`CompletableFuture<AppResponse>`	`getResponseFuture()`
`Object`	`getValue()` Notice the return type of `getValue()` is the actual type of the RPC method, not `AppResponse`
`boolean`	`hasException()` Has exception.
`static AsyncRpcResult`	`newDefaultAsyncResult(AppResponse appResponse, Invocation invocation)` Some utility methods used to quickly generate default AsyncRpcResult instance.
`static AsyncRpcResult`	`newDefaultAsyncResult(Invocation invocation)`
`static AsyncRpcResult`	`newDefaultAsyncResult(Object value, Invocation invocation)`
`static AsyncRpcResult`	`newDefaultAsyncResult(Object value, Throwable t, Invocation invocation)`
`static AsyncRpcResult`	`newDefaultAsyncResult(Throwable t, Invocation invocation)`
`Object`	`recreate()` Recreate.
`void`	`setAttachment(String key, Object value)`
`void`	`setAttachment(String key, String value)`
`void`	`setAttachments(Map<String,String> map)` Replace the existing attachments with the specified param.
`void`	`setException(Throwable t)`
`void`	`setExecutor(Executor executor)`
`void`	`setObjectAttachment(String key, Object value)`
`void`	`setObjectAttachments(Map<String,Object> map)` Replace the existing attachments with the specified param.
`void`	`setResponseFuture(CompletableFuture<AppResponse> responseFuture)`
`void`	`setValue(Object value)` CompletableFuture can only be completed once, so try to update the result of one completed CompletableFuture will has no effect.
`<U> CompletableFuture<U>`	`thenApply(Function<Result,? extends U> fn)`
`Result`	`whenCompleteWithContext(BiConsumer<Result,Throwable> fn)` Add a callback which can be triggered when the RPC call finishes.

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - AsyncRpcResult
```
public AsyncRpcResult(CompletableFuture<AppResponse> future,
                      Invocation invocation)
```
- 方法详细资料
  - getValue
```
public Object getValue()
```
    Notice the return type of getValue() is the actual type of the RPC method, not AppResponse
    
    指定者:
    
    getValue 在接口中 Result
    
    返回:
  - setValue
```
public void setValue(Object value)
```
    CompletableFuture can only be completed once, so try to update the result of one completed CompletableFuture will has no effect. To avoid this problem, we check the complete status of this future before update it's value. But notice that trying to give an uncompleted CompletableFuture a new specified value may face a race condition, because the background thread watching the real result will also change the status of this CompletableFuture. The result is you may lose the value you expected to set.
    
    指定者:
    
    setValue 在接口中 Result
    
    参数:
    
    value -
  - getException
```
public Throwable getException()
```
    从接口复制的说明: Result
    
    Get exception.
    
    指定者:
    
    getException 在接口中 Result
    
    返回:
    
    exception. if no exception return null.
  - setException
```
public void setException(Throwable t)
```
    指定者:
    
    setException 在接口中 Result
  - hasException
```
public boolean hasException()
```
    从接口复制的说明: Result
    
    Has exception.
    
    指定者:
    
    hasException 在接口中 Result
    
    返回:
    
    has exception.
  - getResponseFuture
```
public CompletableFuture<AppResponse> getResponseFuture()
```
  - setResponseFuture
```
public void setResponseFuture(CompletableFuture<AppResponse> responseFuture)
```
  - getAppResponse
```
public Result getAppResponse()
```
  - get
```
public Result get()
           throws InterruptedException,
                  ExecutionException
```
    This method will always return after a maximum 'timeout' waiting: 1. if value returns before timeout, return normally. 2. if no value returns after timeout, throw TimeoutException.
    
    指定者:
    
    get 在接口中 Result
    
    返回:
    
    抛出:
    
    InterruptedException
    
    ExecutionException
  - get
```
public Result get(long timeout,
                  TimeUnit unit)
           throws InterruptedException,
                  ExecutionException,
                  TimeoutException
```
    指定者:
    
    get 在接口中 Result
    
    抛出:
    
    InterruptedException
    
    ExecutionException
    
    TimeoutException
  - recreate
```
public Object recreate()
                throws Throwable
```
    从接口复制的说明: Result
    
    Recreate.
    if (hasException()) { throw getException(); } else { return getValue(); }
    
    指定者:
    
    recreate 在接口中 Result
    
    返回:
    
    result.
    
    抛出:
    
    Throwable
  - whenCompleteWithContext
```
public Result whenCompleteWithContext(BiConsumer<Result,Throwable> fn)
```
    从接口复制的说明: Result
    
    Add a callback which can be triggered when the RPC call finishes.
    Just as the method name implies, this method will guarantee the callback being triggered under the same context as when the call was started, see implementation in Result.whenCompleteWithContext(BiConsumer)
    
    指定者:
    
    whenCompleteWithContext 在接口中 Result
    
    返回:
  - thenApply
```
public <U> CompletableFuture<U> thenApply(Function<Result,? extends U> fn)
```
    指定者:
    
    thenApply 在接口中 Result
  - getAttachments
```
@Deprecated
public Map<String,String> getAttachments()
```
    已过时。
    
    从接口复制的说明: Result
    
    get attachments.
    
    指定者:
    
    getAttachments 在接口中 Result
    
    返回:
    
    attachments.
  - getObjectAttachments
```
public Map<String,Object> getObjectAttachments()
```
    从接口复制的说明: Result
    
    get attachments.
    
    指定者:
    
    getObjectAttachments 在接口中 Result
    
    返回:
    
    attachments.
  - setAttachments
```
public void setAttachments(Map<String,String> map)
```
    从接口复制的说明: Result
    
    Replace the existing attachments with the specified param.
    
    指定者:
    
    setAttachments 在接口中 Result
  - setObjectAttachments
```
public void setObjectAttachments(Map<String,Object> map)
```
    从接口复制的说明: Result
    
    Replace the existing attachments with the specified param.
    
    指定者:
    
    setObjectAttachments 在接口中 Result
  - addAttachments
```
@Deprecated
public void addAttachments(Map<String,String> map)
```
    已过时。
    
    从接口复制的说明: Result
    
    Add the specified map to existing attachments in this instance.
    
    指定者:
    
    addAttachments 在接口中 Result
  - addObjectAttachments
```
public void addObjectAttachments(Map<String,Object> map)
```
    从接口复制的说明: Result
    
    Add the specified map to existing attachments in this instance.
    
    指定者:
    
    addObjectAttachments 在接口中 Result
  - getAttachment
```
public String getAttachment(String key)
```
    从接口复制的说明: Result
    
    get attachment by key.
    
    指定者:
    
    getAttachment 在接口中 Result
    
    返回:
    
    attachment value.
  - getObjectAttachment
```
public Object getObjectAttachment(String key)
```
    从接口复制的说明: Result
    
    get attachment by key.
    
    指定者:
    
    getObjectAttachment 在接口中 Result
    
    返回:
    
    attachment value.
  - getAttachment
```
public String getAttachment(String key,
                            String defaultValue)
```
    从接口复制的说明: Result
    
    get attachment by key with default value.
    
    指定者:
    
    getAttachment 在接口中 Result
    
    返回:
    
    attachment value.
  - getObjectAttachment
```
public Object getObjectAttachment(String key,
                                  Object defaultValue)
```
    从接口复制的说明: Result
    
    get attachment by key with default value.
    
    指定者:
    
    getObjectAttachment 在接口中 Result
    
    返回:
    
    attachment value.
  - setAttachment
```
public void setAttachment(String key,
                          String value)
```
    指定者:
    
    setAttachment 在接口中 Result
  - setAttachment
```
public void setAttachment(String key,
                          Object value)
```
    指定者:
    
    setAttachment 在接口中 Result
  - setObjectAttachment
```
public void setObjectAttachment(String key,
                                Object value)
```
    指定者:
    
    setObjectAttachment 在接口中 Result
  - getExecutor
```
public Executor getExecutor()
```
  - setExecutor
```
public void setExecutor(Executor executor)
```
  - newDefaultAsyncResult
```
public static AsyncRpcResult newDefaultAsyncResult(AppResponse appResponse,
                                                   Invocation invocation)
```
    Some utility methods used to quickly generate default AsyncRpcResult instance.
  - newDefaultAsyncResult
```
public static AsyncRpcResult newDefaultAsyncResult(Invocation invocation)
```
  - newDefaultAsyncResult
```
public static AsyncRpcResult newDefaultAsyncResult(Object value,
                                                   Invocation invocation)
```
  - newDefaultAsyncResult
```
public static AsyncRpcResult newDefaultAsyncResult(Throwable t,
                                                   Invocation invocation)
```
  - newDefaultAsyncResult
```
public static AsyncRpcResult newDefaultAsyncResult(Object value,
                                                   Throwable t,
                                                   Invocation invocation)
```

类 AsyncRpcResult

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

AsyncRpcResult

方法详细资料

getValue

setValue

getException

setException

hasException

getResponseFuture

setResponseFuture

getAppResponse

get

get

recreate

whenCompleteWithContext

thenApply

getAttachments

getObjectAttachments

setAttachments

setObjectAttachments

addAttachments

addObjectAttachments

getAttachment

getObjectAttachment

getAttachment

getObjectAttachment

setAttachment

setAttachment

setObjectAttachment

getExecutor

setExecutor

newDefaultAsyncResult

newDefaultAsyncResult

newDefaultAsyncResult

newDefaultAsyncResult

newDefaultAsyncResult