WebSocketNode (Redkale 1.9.6 API)

java.lang.Object
- org.redkale.net.http.WebSocketNode

直接已知子类:

WebSocketNodeService
```
public abstract class WebSocketNode
extends Object
```
详情见: https://redkale.org

作者:

zhangjx

字段概要

字段
限定符和类型	字段和说明
`protected WebSocketEngine`	`localEngine`
`protected InetSocketAddress`	`localSncpAddress`
`protected Logger`	`logger`
`protected WebSocketNode`	`remoteNode`
`protected Semaphore`	`semaphore`
`protected Convert`	`sendConvert`
`protected CacheSource<InetSocketAddress>`	`sncpNodeAddresses`
`static String`	`SOURCE_SNCP_ADDRS_KEY`
`static String`	`SOURCE_SNCP_USERID_PREFIX`

构造器概要

构造器
构造器和说明

WebSocketNode()

构造器
构造器和说明
`WebSocketNode()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`CompletableFuture<Integer>`	`broadcastMessage(Convert convert, Object message)` 广播消息，给所有人发消息
`CompletableFuture<Integer>`	`broadcastMessage(Convert convert, Object message0, boolean last)` 广播消息，给所有人发消息
`protected abstract CompletableFuture<Integer>`	`broadcastMessage(InetSocketAddress targetAddress, WebSocketRange wsrange, Object message, boolean last)`
`CompletableFuture<Integer>`	`broadcastMessage(Object message)` 广播消息，给所有人发消息
`CompletableFuture<Integer>`	`broadcastMessage(Object message, boolean last)` 广播消息，给所有人发消息
`CompletableFuture<Integer>`	`broadcastMessage(WebSocketRange wsrange, Convert convert, Object message)` 广播消息，给所有人发消息
`CompletableFuture<Integer>`	`broadcastMessage(WebSocketRange wsrange, Convert convert, Object message0, boolean last)` 广播消息，给所有人发消息
`CompletableFuture<Integer>`	`broadcastMessage(WebSocketRange wsrange, Object message)` 广播消息，给所有人发消息
`CompletableFuture<Integer>`	`broadcastMessage(WebSocketRange wsrange, Object message, boolean last)` 广播消息，给所有人发消息
`protected abstract CompletableFuture<Void>`	`changeUserid(Serializable fromuserid, Serializable touserid, InetSocketAddress sncpAddr)`
`protected abstract CompletableFuture<Void>`	`connect(Serializable userid, InetSocketAddress sncpAddr)`
`void`	`destroy(AnyValue conf)`
`protected abstract CompletableFuture<Void>`	`disconnect(Serializable userid, InetSocketAddress sncpAddr)`
`CompletableFuture<Boolean>`	`existsWebSocket(Serializable userid)` 判断指定用户是否WebSocket在线
`CompletableFuture<Integer>`	`forceCloseWebSocket(Serializable userid)` 强制关闭用户WebSocket
`protected abstract CompletableFuture<Integer>`	`forceCloseWebSocket(Serializable userid, InetSocketAddress targetAddress)`
`protected Object`	`formatRemoteMessage(Object message)`
`WebSocketEngine`	`getLocalWebSocketEngine()` 获取本地的WebSocketEngine，没有则返回null
`CompletableFuture<Collection<InetSocketAddress>>`	`getRpcNodeAddresses(Serializable userid)` 获取用户在线的SNCP节点地址列表，不是分布式则返回元素数量为1，且元素值为null的列表 InetSocketAddress 为 SNCP节点地址
`CompletableFuture<Map<InetSocketAddress,List<String>>>`	`getRpcNodeWebSocketAddresses(Serializable userid)` 获取在线用户的详细连接信息 Map.key 为 SNCP节点地址, 含值为null的key表示没有分布式 Map.value 为用户客户端的IP
`Semaphore`	`getSemaphore()`
`CompletableFuture<Integer>`	`getUserSize()` 获取在线用户总数
`protected abstract CompletableFuture<List<String>>`	`getWebSocketAddresses(InetSocketAddress targetAddress, Serializable userid)`
`void`	`init(AnyValue conf)`
`void`	`postDestroy(AnyValue conf)`
`protected void`	`releaseSemaphore()`
`protected CompletableFuture<List<String>>`	`remoteWebSocketAddresses(InetSocketAddress targetAddress, Serializable userid)` 获取目标地址该方法仅供内部调用
`CompletableFuture<Integer>`	`sendMessage(Convert convert, Object message0, boolean last, Serializable... userids)` 向指定用户发送消息，先发送本地连接，再发送远程连接如果当前WebSocketNode是远程模式，此方法只发送远程连接
`CompletableFuture<Integer>`	`sendMessage(Convert convert, Object message0, boolean last, Stream<? extends Serializable> userids)` 向指定用户发送消息，先发送本地连接，再发送远程连接如果当前WebSocketNode是远程模式，此方法只发送远程连接
`CompletableFuture<Integer>`	`sendMessage(Convert convert, Object message, Serializable... userids)` 向指定用户发送消息，先发送本地连接，再发送远程连接如果当前WebSocketNode是远程模式，此方法只发送远程连接
`CompletableFuture<Integer>`	`sendMessage(Convert convert, Object message, Stream<? extends Serializable> userids)` 向指定用户发送消息，先发送本地连接，再发送远程连接如果当前WebSocketNode是远程模式，此方法只发送远程连接
`protected abstract CompletableFuture<Integer>`	`sendMessage(InetSocketAddress targetAddress, Object message, boolean last, Serializable userid)`
`CompletableFuture<Integer>`	`sendMessage(Object message, boolean last, Serializable... userids)` 向指定用户发送消息，先发送本地连接，再发送远程连接如果当前WebSocketNode是远程模式，此方法只发送远程连接
`CompletableFuture<Integer>`	`sendMessage(Object message, boolean last, Stream<? extends Serializable> userids)` 向指定用户发送消息，先发送本地连接，再发送远程连接如果当前WebSocketNode是远程模式，此方法只发送远程连接
`CompletableFuture<Integer>`	`sendMessage(Object message, Serializable... userids)` 向指定用户发送消息，先发送本地连接，再发送远程连接如果当前WebSocketNode是远程模式，此方法只发送远程连接
`CompletableFuture<Integer>`	`sendMessage(Object message, Stream<? extends Serializable> userids)` 向指定用户发送消息，先发送本地连接，再发送远程连接如果当前WebSocketNode是远程模式，此方法只发送远程连接
`protected CompletableFuture<Integer>`	`sendOneMessage(Object message, boolean last, Serializable userid)`
`protected boolean`	`tryAcquireSemaphore()`

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

字段详细资料

SOURCE_SNCP_USERID_PREFIX

@Comment(value="\u5b58\u50a8\u7528\u6237ID\u7684key\u524d\u7f00")
public static final String SOURCE_SNCP_USERID_PREFIX

另请参阅:: 常量字段值

SOURCE_SNCP_ADDRS_KEY

@Comment(value="\u5b58\u50a8\u5f53\u524dSNCP\u8282\u70b9\u5217\u8868\u7684key")
public static final String SOURCE_SNCP_ADDRS_KEY

另请参阅:: 常量字段值

logger
```
protected final Logger logger
```

localSncpAddress

protected InetSocketAddress localSncpAddress

remoteNode

@RpcRemote
protected WebSocketNode remoteNode

sendConvert
```
protected Convert sendConvert
```

sncpNodeAddresses

protected CacheSource<InetSocketAddress> sncpNodeAddresses

localEngine
```
protected WebSocketEngine localEngine
```

semaphore
```
protected Semaphore semaphore
```

构造器详细资料
- WebSocketNode
```
public WebSocketNode()
```

方法详细资料

init
```
public void init(AnyValue conf)
```

destroy
```
public void destroy(AnyValue conf)
```

getSemaphore

@Local
public final Semaphore getSemaphore()

postDestroy

@Local
public final void postDestroy(AnyValue conf)

getWebSocketAddresses

protected abstract CompletableFuture<List<String>> getWebSocketAddresses(@RpcTargetAddress
                                                                         InetSocketAddress targetAddress,
                                                                         Serializable userid)

sendMessage

protected abstract CompletableFuture<Integer> sendMessage(@RpcTargetAddress
                                                          InetSocketAddress targetAddress,
                                                          Object message,
                                                          boolean last,
                                                          Serializable userid)

broadcastMessage

protected abstract CompletableFuture<Integer> broadcastMessage(@RpcTargetAddress
                                                               InetSocketAddress targetAddress,
                                                               WebSocketRange wsrange,
                                                               Object message,
                                                               boolean last)

connect

protected abstract CompletableFuture<Void> connect(Serializable userid,
                                                   InetSocketAddress sncpAddr)

disconnect

protected abstract CompletableFuture<Void> disconnect(Serializable userid,
                                                      InetSocketAddress sncpAddr)

changeUserid

protected abstract CompletableFuture<Void> changeUserid(Serializable fromuserid,
                                                        Serializable touserid,
                                                        InetSocketAddress sncpAddr)

forceCloseWebSocket

protected abstract CompletableFuture<Integer> forceCloseWebSocket(Serializable userid,
                                                                  @RpcTargetAddress
                                                                  InetSocketAddress targetAddress)

remoteWebSocketAddresses

protected CompletableFuture<List<String>> remoteWebSocketAddresses(@RpcTargetAddress
                                                                   InetSocketAddress targetAddress,
                                                                   Serializable userid)

获取目标地址
该方法仅供内部调用

参数:: targetAddress - InetSocketAddress; userid - Serializable
返回:: 客户端地址列表

getRpcNodeAddresses
```
public CompletableFuture<Collection<InetSocketAddress>> getRpcNodeAddresses(Serializable userid)
```
获取用户在线的SNCP节点地址列表，不是分布式则返回元素数量为1，且元素值为null的列表
InetSocketAddress 为 SNCP节点地址

参数:

userid - Serializable

返回:

地址列表

getRpcNodeWebSocketAddresses
```
public CompletableFuture<Map<InetSocketAddress,List<String>>> getRpcNodeWebSocketAddresses(Serializable userid)
```
获取在线用户的详细连接信息
Map.key 为 SNCP节点地址, 含值为null的key表示没有分布式 Map.value 为用户客户端的IP

参数:

userid - Serializable

返回:

地址集合

existsWebSocket
```
public CompletableFuture<Boolean> existsWebSocket(Serializable userid)
```
判断指定用户是否WebSocket在线

参数:

userid - Serializable

返回:

boolean

getUserSize

public CompletableFuture<Integer> getUserSize()

获取在线用户总数

返回:: boolean

forceCloseWebSocket

@Local
public CompletableFuture<Integer> forceCloseWebSocket(Serializable userid)

强制关闭用户WebSocket

参数:: userid - Serializable
返回:: int

getLocalWebSocketEngine
```
@Local
public final WebSocketEngine getLocalWebSocketEngine()
```
获取本地的WebSocketEngine，没有则返回null

返回:

WebSocketEngine

sendMessage
```
@Local
public final CompletableFuture<Integer> sendMessage(Object message,
                                                           Stream<? extends Serializable> userids)
```
向指定用户发送消息，先发送本地连接，再发送远程连接
如果当前WebSocketNode是远程模式，此方法只发送远程连接

参数:

message - 消息内容

userids - Stream

返回:

为0表示成功，其他值表示部分发送异常

sendMessage
```
@Local
public final CompletableFuture<Integer> sendMessage(Object message,
                                                           Serializable... userids)
```
向指定用户发送消息，先发送本地连接，再发送远程连接
如果当前WebSocketNode是远程模式，此方法只发送远程连接

参数:

message - 消息内容

userids - Serializable[]

返回:

为0表示成功，其他值表示部分发送异常