org.noear.socketd.cluster

类 ClusterClientSession

java.lang.Object

org.noear.socketd.cluster.ClusterClientSession

所有已实现的接口:

Closeable, AutoCloseable, ClientSession

public class ClusterClientSession
extends Object
implements ClientSession

集群客户端会话

从以下版本开始:

2.1

作者:

noear

构造器概要

构造器

构造器和说明
ClusterClientSession(List<ClientSession> sessions)

方法概要

限定符和类型	方法和说明
void	close() 关闭
List<ClientSession>	getSessionAll() 获取所有会话
ClientSession	getSessionAny(String diversionOrNull) 获取任意一个会话
ClientSession	getSessionOne() 已过时。 2.3
boolean	isClosing() 是否正在关闭中
boolean	isValid() 是否有效
void	preclose() 预关闭（发送预关闭指令，通知对端不要再主动发消息过来了）
void	reconnect() 重新连接
SendStream	send(String event, Entity entity) 发送
RequestStream	sendAndRequest(String event, Entity entity, long timeout) 发送并请求（限为一次答复；指定超时）
SubscribeStream	sendAndSubscribe(String event, Entity entity, long timeout) 发送并订阅（答复结束之前，不限答复次数）
String	sessionId() 获取会话Id

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

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

从接口继承的方法 org.noear.socketd.transport.client.ClientSession

closeStarting, sendAndRequest, sendAndSubscribe

构造器详细资料

ClusterClientSession

public ClusterClientSession(List<ClientSession> sessions)

方法详细资料

getSessionAll

public List<ClientSession> getSessionAll()

获取所有会话

getSessionAny

public ClientSession getSessionAny(String diversionOrNull)

获取任意一个会话

参数:

diversionOrNull - 分流（或者 null）

从以下版本开始:

2.3

getSessionOne

@Deprecated
public ClientSession getSessionOne()

已过时。 2.3

获取任意一个会话（轮询负栽均衡）

isValid

public boolean isValid()

从接口复制的说明: ClientSession

是否有效

指定者:

isValid 在接口中 ClientSession

isClosing

public boolean isClosing()

从接口复制的说明: ClientSession

是否正在关闭中

指定者:

isClosing 在接口中 ClientSession

sessionId

public String sessionId()

从接口复制的说明: ClientSession

获取会话Id

指定者:

sessionId 在接口中 ClientSession

send

public SendStream send(String event,
                       Entity entity)
                throws IOException

发送

指定者:

send 在接口中 ClientSession

参数:

event - 事件

entity - 实体

返回:

流

抛出:

IOException

sendAndRequest

public RequestStream sendAndRequest(String event,
                                    Entity entity,
                                    long timeout)
                             throws IOException

发送并请求（限为一次答复；指定超时）

指定者:

sendAndRequest 在接口中 ClientSession

参数:

event - 事件

entity - 实体

timeout - 超时（单位：毫秒）

返回:

流

抛出:

IOException

sendAndSubscribe

public SubscribeStream sendAndSubscribe(String event,
                                        Entity entity,
                                        long timeout)
                                 throws IOException

发送并订阅（答复结束之前，不限答复次数）

指定者:

sendAndSubscribe 在接口中 ClientSession

参数:

event - 事件

entity - 实体

timeout - 超时（单位：毫秒）

返回:

流

抛出:

IOException

preclose

public void preclose()
              throws IOException

从接口复制的说明: ClientSession

预关闭（发送预关闭指令，通知对端不要再主动发消息过来了）

指定者:

preclose 在接口中 ClientSession

抛出:

IOException

close

public void close()
           throws IOException

关闭

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 ClientSession

抛出:

IOException

reconnect

public void reconnect()
               throws IOException

重新连接

指定者:

reconnect 在接口中 ClientSession

抛出:

IOException