RpcInternalContext (com.alipay.sofa:sofa-rpc-all 5.4.0 API)

java.lang.Object
- com.alipay.sofa.rpc.context.RpcInternalContext

所有已实现的接口:

Cloneable
```
public class RpcInternalContext
extends Object
implements Cloneable
```
基于ThreadLocal的内部使用的上下文传递。一般存在于：客户端请求线程、服务端业务线程池、客户端异步线程

构造器概要

构造器
限定符构造器和说明

protected RpcInternalContext()
Instantiates a new Rpc context.

构造器
限定符	构造器和说明
`protected`	`RpcInternalContext()` Instantiates a new Rpc context.

方法概要

方法
限定符和类型	方法和说明
`void`	`clear()` Clear context for next user
`RpcInternalContext`	`clearAttachments()` Clear attachments.
`RpcInternalContext`	`clone()`
`Object`	`getAttachment(String key)` get attachment.
`Map<String,Object>`	`getAttachments()` get attachments.
`static RpcInternalContext`	`getContext()` 得到上下文，为空则自动创建
`<T> ResponseFuture<T>`	`getFuture()` get future.
`InetSocketAddress`	`getLocalAddress()` 本地地址InetSocketAddress
`ProviderInfo`	`getProviderInfo()` Gets provider info.
`InetSocketAddress`	`getRemoteAddress()` 远程地址InetSocketAddress
`String`	`getRemoteHostName()` 远程IP地址
`StopWatch`	`getStopWatch()` Gets stop watch.
`static boolean`	`isAttachmentEnable()` 是否开启附件传递功能
`boolean`	`isConsumerSide()` Is consumer side.
`boolean`	`isProviderSide()` Is provider side.
`static boolean`	`isValidInternalParamKey(String key)` 合法的内置key，以"_"或者"."
`static RpcInternalContext`	`peekContext()` 查看上下文，为空不自动创建
`static void`	`popContext()` 上下文往上取一层（例如服务端B接到A的请求后再作为C的客户端调用，调用完毕后这里就先把放A-B的上下文取起来）
`static void`	`pushContext()` 上下文往下放一层（例如服务端B接到A的请求后再作为C的客户端调用，调用前这里就先把放A-B的上下文存起来）
`static void`	`removeAllContext()` 清理全部上下文
`Object`	`removeAttachment(String key)` remove attachment.
`static void`	`removeContext()` 清理上下文
`RpcInternalContext`	`setAttachment(String key, Object value)` set attachment.
`RpcInternalContext`	`setAttachments(Map<String,Object> attachments)` key不能以点和下划线开头
`static void`	`setContext(RpcInternalContext context)` 设置上下文
`RpcInternalContext`	`setFuture(ResponseFuture<?> future)` set future.
`RpcInternalContext`	`setLocalAddress(InetSocketAddress address)` set local address.
`RpcInternalContext`	`setLocalAddress(String host, int port)` 已过时。
`RpcInternalContext`	`setProviderInfo(ProviderInfo providerInfo)` Sets provider info.
`RpcInternalContext`	`setProviderSide(Boolean isProviderSide)` Sets provider side.
`RpcInternalContext`	`setRemoteAddress(InetSocketAddress address)` set remote address.
`RpcInternalContext`	`setRemoteAddress(String host, int port)` set remote address.
`String`	`toString()`

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

- 构造器详细资料
  - RpcInternalContext
```
protected RpcInternalContext()
```
    Instantiates a new Rpc context.
- 方法详细资料
  - setContext
```
public static void setContext(RpcInternalContext context)
```
    设置上下文
    
    参数:
    context - RPC内置上下文
  - getContext
```
public static RpcInternalContext getContext()
```
    得到上下文，为空则自动创建
    
    返回:
    RPC内置上下文
  - peekContext
```
public static RpcInternalContext peekContext()
```
    查看上下文，为空不自动创建
    
    返回:
    RPC内置上下文
  - removeContext
```
public static void removeContext()
```
    清理上下文
  - pushContext
```
public static void pushContext()
```
    上下文往下放一层（例如服务端B接到A的请求后再作为C的客户端调用，调用前这里就先把放A-B的上下文存起来）
  - popContext
```
public static void popContext()
```
    上下文往上取一层（例如服务端B接到A的请求后再作为C的客户端调用，调用完毕后这里就先把放A-B的上下文取起来）
  - removeAllContext
```
public static void removeAllContext()
```
    清理全部上下文
  - isAttachmentEnable
```
public static boolean isAttachmentEnable()
```
    是否开启附件传递功能
    
    返回:
    是否开启附件传递功能
  - isProviderSide
```
public boolean isProviderSide()
```
    Is provider side.
    
    返回:
    the boolean
  - setProviderSide
```
public RpcInternalContext setProviderSide(Boolean isProviderSide)
```
    Sets provider side.
    
    参数:
    isProviderSide - the is provider side
    
    返回:
    the provider side
  - isConsumerSide
```
public boolean isConsumerSide()
```
    Is consumer side.
    
    返回:
    the boolean
  - getFuture
```
public <T> ResponseFuture<T> getFuture()
```
    get future.
    
    类型参数:
    T - the type parameter
    
    返回:
    future future
  - setFuture
```
public RpcInternalContext setFuture(ResponseFuture<?> future)
```
    set future.
    
    参数:
    future - the future
    
    返回:
    RpcInternalContext future
  - setLocalAddress
```
public RpcInternalContext setLocalAddress(InetSocketAddress address)
```
    set local address.
    
    参数:
    address - the address
    
    返回:
    context local address
  - setLocalAddress
```
@Deprecated
public RpcInternalContext setLocalAddress(String host,
                                            int port)
```
    已过时。
    
    set local address.
    
    参数:
    host - the host
    port - the port
    
    返回:
    context local address
  - getLocalAddress
```
public InetSocketAddress getLocalAddress()
```
    本地地址InetSocketAddress
    
    返回:
    local address
  - setRemoteAddress
```
public RpcInternalContext setRemoteAddress(InetSocketAddress address)
```
    set remote address.
    
    参数:
    address - the address
    
    返回:
    context remote address
  - setRemoteAddress
```
public RpcInternalContext setRemoteAddress(String host,
                                  int port)
```
    set remote address.
    
    参数:
    host - the host
    port - the port
    
    返回:
    context remote address
  - getRemoteAddress
```
public InetSocketAddress getRemoteAddress()
```
    远程地址InetSocketAddress
    
    返回:
    remote address
  - getRemoteHostName
```
public String getRemoteHostName()
```
    远程IP地址
    
    返回:
    remote host name
  - getAttachment
```
public Object getAttachment(String key)
```
    get attachment.
    
    参数:
    key - the key
    
    返回:
    attachment attachment
  - setAttachment
```
public RpcInternalContext setAttachment(String key,
                               Object value)
```
    set attachment.
    
    参数:
    key - the key
    value - the value
    
    返回:
    context attachment
  - removeAttachment
```
public Object removeAttachment(String key)
```
    remove attachment.
    
    参数:
    key - the key
    
    返回:
    Old value
  - getAttachments
```
public Map<String,Object> getAttachments()
```
    get attachments.
    
    返回:
    attachments attachments
  - setAttachments
```
public RpcInternalContext setAttachments(Map<String,Object> attachments)
```
    key不能以点和下划线开头
    
    参数:
    attachments - the attachments
    
    返回:
    context attachments
  - clearAttachments
```
public RpcInternalContext clearAttachments()
```
    Clear attachments.
    
    返回:
    the rpc internal context
  - getStopWatch
```
public StopWatch getStopWatch()
```
    Gets stop watch.
    
    返回:
    the stop watch
  - clear
```
public void clear()
```
    Clear context for next user
  - setProviderInfo
```
public RpcInternalContext setProviderInfo(ProviderInfo providerInfo)
```
    Sets provider info.
    
    参数:
    providerInfo - the provider info
    
    返回:
    the provider info
  - getProviderInfo
```
public ProviderInfo getProviderInfo()
```
    Gets provider info.
    
    返回:
    the provider info
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - clone
```
public RpcInternalContext clone()
```
    覆盖:
    
    clone 在类中 Object
  - isValidInternalParamKey
```
public static boolean isValidInternalParamKey(String key)
```
    合法的内置key，以"_"或者"."开头
    
    参数:
    key - 参数key
    
    返回:
    是否合法

类 RpcInternalContext

构造器概要

方法概要

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

构造器详细资料

RpcInternalContext

方法详细资料

setContext

getContext

peekContext

removeContext

pushContext

popContext

removeAllContext

isAttachmentEnable

isProviderSide

setProviderSide

isConsumerSide

getFuture

setFuture

setLocalAddress

setLocalAddress

getLocalAddress

setRemoteAddress

setRemoteAddress

getRemoteAddress

getRemoteHostName

getAttachment

setAttachment

removeAttachment

getAttachments

setAttachments

clearAttachments

getStopWatch

clear

setProviderInfo

getProviderInfo

toString

clone

isValidInternalParamKey