org.noear.socketd.transport.client

接口 ClientSession

所有超级接口:

AutoCloseable, Closeable

所有已知子接口:

Session

所有已知实现类:

ClusterClientSession, SessionBase, SessionDefault

public interface ClientSession
extends Closeable

客户会话

作者:

noear

方法概要

限定符和类型	方法和说明
void	close() 关闭（发送关闭指令，并关闭连接）
default void	closeStarting() 已过时。 2.4
boolean	isClosing() 是否正在关闭中
boolean	isValid() 是否有效
void	preclose() 预关闭（发送预关闭指令，通知对端不要再主动发消息过来了）
void	reconnect() 手动重连（一般是自动）
SendStream	send(String event, Entity entity) 发送
default RequestStream	sendAndRequest(String event, Entity entity) 发送并请求
RequestStream	sendAndRequest(String event, Entity entity, long timeout) 发送并请求
default SubscribeStream	sendAndSubscribe(String event, Entity entity) 发送并订阅（答复结束之前，不限答复次数）
SubscribeStream	sendAndSubscribe(String event, Entity entity, long timeout) 发送并订阅（答复结束之前，不限答复次数）
String	sessionId() 获取会话Id

方法详细资料

isValid

boolean isValid()

是否有效

isClosing

boolean isClosing()

是否正在关闭中

sessionId

String sessionId()

获取会话Id

send

SendStream send(String event,
                Entity entity)
         throws IOException

发送

参数:

event - 事件

entity - 实体

返回:

流

抛出:

IOException

sendAndRequest

default RequestStream sendAndRequest(String event,
                                     Entity entity)
                              throws IOException

发送并请求

参数:

event - 事件

entity - 实体

返回:

流

抛出:

IOException

sendAndRequest

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

发送并请求

参数:

event - 事件

entity - 实体

timeout - 超时（单位：毫秒）

返回:

流

抛出:

IOException

sendAndSubscribe

default SubscribeStream sendAndSubscribe(String event,
                                         Entity entity)
                                  throws IOException

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

参数:

event - 事件

entity - 实体

返回:

流

抛出:

IOException

sendAndSubscribe

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

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

参数:

event - 事件

entity - 实体

timeout - 超时（单位：毫秒）

返回:

流

抛出:

IOException

closeStarting

@Deprecated
default void closeStarting()
                                throws IOException

已过时。 2.4

关闭开始

抛出:

IOException

preclose

void preclose()
       throws IOException

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

抛出:

IOException

close

void close()
    throws IOException

关闭（发送关闭指令，并关闭连接）

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 Closeable

抛出:

IOException

reconnect

void reconnect()
        throws IOException

手动重连（一般是自动）

抛出:

IOException