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

作者:

zhangjx

字段概要

字段

限定符和类型	字段和说明
protected boolean	finest
protected WebSocketEngine	localEngine
protected java.net.InetSocketAddress	localSncpAddress
protected java.util.logging.Logger	logger
protected WebSocketNode	remoteNode
protected CacheSource<java.io.Serializable,java.net.InetSocketAddress>	sncpNodeAddresses

构造器概要

构造器

构造器和说明
WebSocketNode()

方法概要

限定符和类型	方法和说明
protected abstract java.util.concurrent.CompletableFuture<java.lang.Integer>	broadcastMessage(java.net.InetSocketAddress targetAddress, 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) 广播消息， 给所有人发消息
protected abstract java.util.concurrent.CompletableFuture<java.lang.Void>	connect(java.io.Serializable userid, java.net.InetSocketAddress addr)
void	destroy(AnyValue conf)
protected abstract java.util.concurrent.CompletableFuture<java.lang.Void>	disconnect(java.io.Serializable userid, java.net.InetSocketAddress addr)
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
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)
void	postDestroy(AnyValue conf)
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>	sendMessage(java.net.InetSocketAddress targetAddress, java.lang.Object message, boolean last, java.io.Serializable userid)
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, java.io.Serializable... userids)

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

logger

protected final java.util.logging.Logger logger

finest

protected final boolean finest

localSncpAddress

protected java.net.InetSocketAddress localSncpAddress

remoteNode

@RpcRemote
protected WebSocketNode remoteNode

sncpNodeAddresses

protected CacheSource<java.io.Serializable,java.net.InetSocketAddress> sncpNodeAddresses

localEngine

protected WebSocketEngine localEngine

构造器详细资料

WebSocketNode

public WebSocketNode()

方法详细资料

init

public void init(AnyValue conf)

destroy

public void destroy(AnyValue conf)

postDestroy

public final 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 userid)

broadcastMessage

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

connect

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

disconnect

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

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

返回:

地址集合

sendMessage

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

sendMessage

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表示成功， 其他值表示部分发送异常

broadcastMessage

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

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

参数:

message - 消息内容

返回:

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

broadcastMessage

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

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

参数:

message - 消息内容

last - 是否最后一条

返回:

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