org.noear.socketd.transport.core

接口 Channel

所有已知子接口:

ChannelInternal

所有已知实现类:

ChannelBase, ChannelDefault, ClientChannel

public interface Channel

通道

从以下版本开始:

2.0

作者:

noear

方法概要

限定符和类型	方法和说明
void	close(int code) 关闭（1协议关，2用户关）
<T> T	getAttachment(String name) 获取附件
Config	getConfig() 获取配置
HandshakeInternal	getHandshake() 获取握手信息
long	getLiveTime() 最后活动时间
InetSocketAddress	getLocalAddress() 获取本地地址
InetSocketAddress	getRemoteAddress() 获取远程地址
Session	getSession() 获取会话
int	isClosed() 是否已关闭
boolean	isClosing() 是否正在关闭
boolean	isValid() 是否有效
void	onError(Throwable error) 出错时
void	putAttachment(String name, Object val) 放置附件
void	reconnect() 手动重连（一般是自动）
void	retrieve(Frame frame, StreamInternal stream) 接收（接收答复帧）
void	send(Frame frame, StreamInternal stream) 发送
void	sendAlarm(Message from, String alarm) 发送告警
void	sendClose(int code) 发送 Close
void	sendConnack() 发送连接确认（握手）
void	sendConnect(String url, Map<String,String> metaMap) 发送连接（握手）
void	sendPing() 发送 Ping（心跳）
void	sendPong() 发送 Pong（心跳）
void	setHandshake(HandshakeInternal handshake) 设置握手信息

方法详细资料

getAttachment

<T> T getAttachment(String name)

获取附件

putAttachment

void putAttachment(String name,
                   Object val)

放置附件

isValid

boolean isValid()

是否有效

isClosing

boolean isClosing()

是否正在关闭

isClosed

int isClosed()

是否已关闭

close

void close(int code)

关闭（1协议关，2用户关）

getLiveTime

long getLiveTime()

最后活动时间

getConfig

Config getConfig()

获取配置

setHandshake

void setHandshake(HandshakeInternal handshake)

设置握手信息

参数:

handshake - 握手信息

getHandshake

HandshakeInternal getHandshake()

获取握手信息

getRemoteAddress

InetSocketAddress getRemoteAddress()
                            throws IOException

获取远程地址

抛出:

IOException

getLocalAddress

InetSocketAddress getLocalAddress()
                           throws IOException

获取本地地址

抛出:

IOException

sendConnect

void sendConnect(String url,
                 Map<String,String> metaMap)
          throws IOException

发送连接（握手）

参数:

url - 连接地址

metaMap - 元信息

抛出:

IOException

sendConnack

void sendConnack()
          throws IOException

发送连接确认（握手）

抛出:

IOException

sendPing

void sendPing()
       throws IOException

发送 Ping（心跳）

抛出:

IOException

sendPong

void sendPong()
       throws IOException

发送 Pong（心跳）

抛出:

IOException

sendClose

void sendClose(int code)
        throws IOException

发送 Close

参数:

code - 关闭代码

抛出:

IOException

sendAlarm

void sendAlarm(Message from,
               String alarm)
        throws IOException

发送告警

抛出:

IOException

send

void send(Frame frame,
          StreamInternal stream)
   throws IOException

发送

参数:

frame - 帧

stream - 流（没有则为 null）

抛出:

IOException

retrieve

void retrieve(Frame frame,
              StreamInternal stream)

接收（接收答复帧）

参数:

frame - 帧

stream - 流

reconnect

void reconnect()
        throws IOException

手动重连（一般是自动）

抛出:

IOException

onError

void onError(Throwable error)

出错时

getSession

Session getSession()

获取会话