org.redkale.net.http

类 WebSocketNode

java.lang.Object

org.redkale.net.http.WebSocketNode

直接已知子类:

WebSocketNodeService

public abstract class WebSocketNode
extends java.lang.Object

详情见: https://redkale.org

字段概要

字段

限定符和类型	字段和说明
protected WebSocketEngine	localEngine
protected java.net.InetSocketAddress	localSncpAddress
protected java.util.logging.Logger	logger
protected WebSocketNode	remoteNode
protected java.util.concurrent.Semaphore	semaphore
protected Convert	sendConvert
protected CacheSource<java.net.InetSocketAddress>	sncpNodeAddresses
static java.lang.String	SOURCE_SNCP_ADDRS_KEY
static java.lang.String	SOURCE_SNCP_USERID_PREFIX

构造器概要

构造器

构造器和说明
WebSocketNode()

方法概要

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

另请参阅:

常量字段值

SOURCE_SNCP_ADDRS_KEY

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

另请参阅:

常量字段值

logger

protected final java.util.logging.Logger logger

localSncpAddress

protected java.net.InetSocketAddress localSncpAddress

remoteNode

@RpcRemote
protected WebSocketNode remoteNode

sendConvert

protected Convert sendConvert

sncpNodeAddresses

protected CacheSource<java.net.InetSocketAddress> sncpNodeAddresses

localEngine

protected WebSocketEngine localEngine

semaphore

protected java.util.concurrent.Semaphore semaphore

构造器详细资料

WebSocketNode

public WebSocketNode()

方法详细资料

init

public void init(AnyValue conf)

destroy

public void destroy(AnyValue conf)

getSemaphore

@Local
public final java.util.concurrent.Semaphore getSemaphore()

postDestroy

@Local
protected void postDestroy(AnyValue conf)

getWebSocketAddresses

protected abstract java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> getWebSocketAddresses(@RpcTargetAddress
                                                                                                                  java.net.InetSocketAddress targetAddress,
                                                                                                                  java.io.Serializable userid)

sendMessage

protected abstract java.util.concurrent.CompletableFuture<java.lang.Integer> sendMessage(@RpcTargetAddress
                                                                                         java.net.InetSocketAddress targetAddress,
                                                                                         java.lang.Object message,
                                                                                         boolean last,
                                                                                         java.io.Serializable... userids)

broadcastMessage

protected abstract java.util.concurrent.CompletableFuture<java.lang.Integer> broadcastMessage(@RpcTargetAddress
                                                                                              java.net.InetSocketAddress targetAddress,
                                                                                              WebSocketRange wsrange,
                                                                                              java.lang.Object message,
                                                                                              boolean last)

sendAction

protected abstract java.util.concurrent.CompletableFuture<java.lang.Integer> sendAction(@RpcTargetAddress
                                                                                        java.net.InetSocketAddress targetAddress,
                                                                                        WebSocketAction action,
                                                                                        java.io.Serializable... userids)

broadcastAction

protected abstract java.util.concurrent.CompletableFuture<java.lang.Integer> broadcastAction(@RpcTargetAddress
                                                                                             java.net.InetSocketAddress targetAddress,
                                                                                             WebSocketAction action)

connect

protected abstract java.util.concurrent.CompletableFuture<java.lang.Void> connect(java.io.Serializable userid,
                                                                                  java.net.InetSocketAddress sncpAddr)

disconnect

protected abstract java.util.concurrent.CompletableFuture<java.lang.Void> disconnect(java.io.Serializable userid,
                                                                                     java.net.InetSocketAddress sncpAddr)

changeUserid

protected abstract java.util.concurrent.CompletableFuture<java.lang.Void> changeUserid(java.io.Serializable fromuserid,
                                                                                       java.io.Serializable touserid,
                                                                                       java.net.InetSocketAddress sncpAddr)

existsWebSocket

protected abstract java.util.concurrent.CompletableFuture<java.lang.Boolean> existsWebSocket(java.io.Serializable userid,
                                                                                             @RpcTargetAddress
                                                                                             java.net.InetSocketAddress targetAddress)

forceCloseWebSocket

protected abstract java.util.concurrent.CompletableFuture<java.lang.Integer> forceCloseWebSocket(java.io.Serializable userid,
                                                                                                 @RpcTargetAddress
                                                                                                 java.net.InetSocketAddress targetAddress)

remoteWebSocketAddresses

protected java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> remoteWebSocketAddresses(@RpcTargetAddress
                                                                                                            java.net.InetSocketAddress targetAddress,
                                                                                                            java.io.Serializable userid)

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

参数:

targetAddress - InetSocketAddress

userid - Serializable

返回:

客户端地址列表

getRpcNodeAddresses

public java.util.concurrent.CompletableFuture<java.util.Collection<java.net.InetSocketAddress>> getRpcNodeAddresses(java.io.Serializable userid)

获取用户在线的SNCP节点地址列表，不是分布式则返回元素数量为1，且元素值为null的列表
InetSocketAddress 为 SNCP节点地址

参数:

userid - Serializable

返回:

地址列表

getRpcNodeWebSocketAddresses

public java.util.concurrent.CompletableFuture<java.util.Map<java.net.InetSocketAddress,java.util.List<java.lang.String>>> getRpcNodeWebSocketAddresses(java.io.Serializable userid)

获取在线用户的详细连接信息
Map.key 为 SNCP节点地址, 含值为null的key表示没有分布式 Map.value 为 用户客户端的IP

参数:

userid - Serializable

返回:

地址集合

getUserSize

public java.util.concurrent.CompletableFuture<java.lang.Integer> getUserSize()

获取在线用户总数

返回:

boolean

existsWebSocket

@Local
public java.util.concurrent.CompletableFuture<java.lang.Boolean> existsWebSocket(java.io.Serializable userid)

判断指定用户是否WebSocket在线

参数:

userid - Serializable

返回:

boolean

forceCloseWebSocket

@Local
public java.util.concurrent.CompletableFuture<java.lang.Integer> forceCloseWebSocket(java.io.Serializable userid)

强制关闭用户WebSocket

参数:

userid - Serializable

返回:

int

getLocalWebSocketEngine

@Local
public final WebSocketEngine getLocalWebSocketEngine()

获取本地的WebSocketEngine，没有则返回null

返回:

WebSocketEngine

sendMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> sendMessage(java.lang.Object message,
                                                                                           java.util.stream.Stream<? extends java.io.Serializable> userids)

向指定用户发送消息，先发送本地连接，再发送远程连接
如果当前WebSocketNode是远程模式，此方法只发送远程连接

参数:

message - 消息内容

userids - Stream

返回:

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

sendMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> sendMessage(java.lang.Object message,
                                                                                           java.io.Serializable... userids)

向指定用户发送消息，先发送本地连接，再发送远程连接
如果当前WebSocketNode是远程模式，此方法只发送远程连接

参数:

message - 消息内容

userids - Serializable[]

返回:

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

sendMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> sendMessage(Convert convert,
                                                                                           java.lang.Object message,
                                                                                           java.util.stream.Stream<? extends java.io.Serializable> userids)

向指定用户发送消息，先发送本地连接，再发送远程连接
如果当前WebSocketNode是远程模式，此方法只发送远程连接

参数:

convert - Convert

message - 消息内容

userids - Stream

返回:

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

sendMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> sendMessage(Convert convert,
                                                                                           java.lang.Object message,
                                                                                           java.io.Serializable... userids)

向指定用户发送消息，先发送本地连接，再发送远程连接
如果当前WebSocketNode是远程模式，此方法只发送远程连接

参数:

convert - Convert

message - 消息内容

userids - Serializable[]

返回:

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

sendMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> sendMessage(java.lang.Object message,
                                                                                           boolean last,
                                                                                           java.util.stream.Stream<? extends java.io.Serializable> userids)

向指定用户发送消息，先发送本地连接，再发送远程连接
如果当前WebSocketNode是远程模式，此方法只发送远程连接

参数:

message - 消息内容

last - 是否最后一条

userids - Stream

返回:

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

sendMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> sendMessage(java.lang.Object message,
                                                                                           boolean last,
                                                                                           java.io.Serializable... userids)

向指定用户发送消息，先发送本地连接，再发送远程连接
如果当前WebSocketNode是远程模式，此方法只发送远程连接

参数:

message - 消息内容

last - 是否最后一条

userids - Serializable[]

返回:

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

sendMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> sendMessage(Convert convert,
                                                                                           java.lang.Object message0,
                                                                                           boolean last,
                                                                                           java.util.stream.Stream<? extends java.io.Serializable> userids)

向指定用户发送消息，先发送本地连接，再发送远程连接
如果当前WebSocketNode是远程模式，此方法只发送远程连接

参数:

convert - Convert

message0 - 消息内容

last - 是否最后一条

userids - Stream

返回:

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

sendMessage

@Local
public java.util.concurrent.CompletableFuture<java.lang.Integer> sendMessage(Convert convert,
                                                                                     java.lang.Object message0,
                                                                                     boolean last,
                                                                                     java.io.Serializable... userids)

向指定用户发送消息，先发送本地连接，再发送远程连接
如果当前WebSocketNode是远程模式，此方法只发送远程连接

参数:

convert - Convert

message0 - 消息内容

last - 是否最后一条

userids - Serializable[]

返回:

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

sendOneUserMessage

protected java.util.concurrent.CompletableFuture<java.lang.Integer> sendOneUserMessage(java.lang.Object message,
                                                                                       boolean last,
                                                                                       java.io.Serializable userid)

sendOneAddrMessage

protected java.util.concurrent.CompletableFuture<java.lang.Integer> sendOneAddrMessage(java.net.InetSocketAddress sncpAddr,
                                                                                       java.lang.Object message,
                                                                                       boolean last,
                                                                                       java.io.Serializable... userids)

broadcastMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> broadcastMessage(java.lang.Object message)

广播消息， 给所有人发消息

参数:

message - 消息内容

返回:

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

broadcastMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> broadcastMessage(WebSocketRange wsrange,
                                                                                                java.lang.Object message)

广播消息， 给所有人发消息

参数:

wsrange - 过滤条件

message - 消息内容

返回:

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

broadcastMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> broadcastMessage(Convert convert,
                                                                                                java.lang.Object message)

广播消息， 给所有人发消息

参数:

convert - Convert

message - 消息内容

返回:

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

broadcastMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> broadcastMessage(WebSocketRange wsrange,
                                                                                                Convert convert,
                                                                                                java.lang.Object message)

广播消息， 给所有人发消息

参数:

wsrange - 过滤条件

convert - Convert

message - 消息内容

返回:

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

broadcastMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> broadcastMessage(java.lang.Object message,
                                                                                                boolean last)

广播消息， 给所有人发消息

参数:

message - 消息内容

last - 是否最后一条

返回:

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

broadcastMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> broadcastMessage(WebSocketRange wsrange,
                                                                                                java.lang.Object message,
                                                                                                boolean last)

广播消息， 给所有人发消息

参数:

wsrange - 过滤条件

message - 消息内容

last - 是否最后一条

返回:

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

broadcastMessage

@Local
public final java.util.concurrent.CompletableFuture<java.lang.Integer> broadcastMessage(Convert convert,
                                                                                                java.lang.Object message0,
                                                                                                boolean last)

广播消息， 给所有人发消息

参数:

convert - Convert

message0 - 消息内容

last - 是否最后一条

返回:

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

broadcastMessage

@Local
public java.util.concurrent.CompletableFuture<java.lang.Integer> broadcastMessage(WebSocketRange wsrange,
                                                                                          Convert convert,
                                                                                          java.lang.Object message0,
                                                                                          boolean last)

广播消息， 给所有人发消息

参数:

wsrange - 过滤条件

convert - Convert

message0 - 消息内容

last - 是否最后一条

返回:

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

broadcastAction

@Local
public java.util.concurrent.CompletableFuture<java.lang.Integer> broadcastAction(WebSocketAction action)

广播操作， 给所有人发操作

参数:

action - 操作参数

返回:

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

sendAction

@Local
public java.util.concurrent.CompletableFuture<java.lang.Integer> sendAction(WebSocketAction action,
                                                                                    java.io.Serializable... userids)

向指定用户发送操作，先发送本地连接，再发送远程连接
如果当前WebSocketNode是远程模式，此方法只发送远程连接

参数:

action - 操作参数

userids - Serializable[]

返回:

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

sendOneUserAction

protected java.util.concurrent.CompletableFuture<java.lang.Integer> sendOneUserAction(WebSocketAction action,
                                                                                      java.io.Serializable userid)

sendOneAddrAction

protected java.util.concurrent.CompletableFuture<java.lang.Integer> sendOneAddrAction(java.net.InetSocketAddress sncpAddr,
                                                                                      WebSocketAction action,
                                                                                      java.io.Serializable... userids)

formatRemoteMessage

protected java.lang.Object formatRemoteMessage(java.lang.Object message)

tryAcquireSemaphore

protected boolean tryAcquireSemaphore()

releaseSemaphore

protected void releaseSemaphore()