org.voovan.network.tcp

Class TcpSocket

java.lang.Object

org.voovan.tools.pool.PooledObject

org.voovan.network.SocketContext<SocketChannel,TcpSession>

org.voovan.network.tcp.TcpSocket

All Implemented Interfaces:

IPooledObject

public class TcpSocket
extends SocketContext<SocketChannel,TcpSession>

NioSocket 连接

Author:

helyho Voovan Framework. WebSite: https://github.com/helyho/Voovan Licence: Apache v2 License

Field Summary

Fields inherited from class org.voovan.network.SocketContext

ACCEPT_THREAD_SIZE, ASYNC_RECIVE, ASYNC_SEND, CHECK_TIMEOUT, COMMON_ACCEPT_EVENT_RUNNER_GROUP, COMMON_IO_EVENT_RUNNER_GROUP, connectModel, connectType, filterChain, handler, host, idleInterval, IO_THREAD_SIZE, isSynchronous, lastReadTime, messageSplitter, port, readBufferSize, readTimeout, reciveFilterChain, SELECT_INTERVAL, sendBufferSize, sendFilterChain, sendTimeout, sslManager

Constructor Summary

Constructors

Constructor and Description
TcpSocket(SocketContext parentSocketContext, SocketChannel socketChannel) 构造函数
TcpSocket(String host, int port, int readTimeout) socket 连接 默认不会出发空闲事件, 默认发超时时间: 1s
TcpSocket(String host, int port, int readTimeout, int idleInterval) socket 连接 默认发超时时间: 1s
TcpSocket(String host, int port, int readTimeout, int sendTimeout, int idleInterval) socket 连接

Method Summary

Modifier and Type	Method and Description
protected void	acceptStart() 用于针对 Accept 进来的 Socket 连接的启动
boolean	close() 关闭连接
TcpSession	getSession() 获取 Session 对象
boolean	isConnected() 上下文连接是否连接
boolean	isOpen() 上下文连接是否打开
void	setIdleInterval(int idleInterval) 设置空闲事件时间
<T> void	setOption(SocketOption<T> name, T value) 设置 Socket 的 Option 选项
SocketChannel	socketChannel() 获取 SocketChannel 对象
void	start() 启动同步的上下文连接, 阻塞方法
Object	syncRead() 同步读取消息
void	syncSend(Object obj) 同步发送消息
void	syncStart() 启动同步的上下文连接 非阻塞方法

Methods inherited from class org.voovan.network.SocketContext

bindToSocketSelector, copyFrom, createEventRunnerGroup, filterChain, getAcceptEventRunnerGroup, getCommonAcceptEventRunnerGroup, getCommonIoEventRunnerGroup, getConnectModel, getConnectType, getHost, getIdleInterval, getIoEventRunnerGroup, getLastReadTime, getPort, getReadBufferSize, getReadTimeout, getReciveFilterChain, getSendBufferSize, getSendFilterChain, getSendTimeout, getSSLManager, gracefulShutdown, handler, handler, initSSL, isRegister, isTimeOut, messageSplitter, messageSplitter, setAcceptEventRunnerGroup, setIoEventRunnerGroup, setReadBufferSize, setRegister, setSendBufferSize, setSSLManager, updateLastTime, waitConnect

Methods inherited from class org.voovan.tools.pool.PooledObject

getPoolObjectId, setPoolObjectId

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpSocket

public TcpSocket(String host,
                 int port,
                 int readTimeout)
          throws IOException

socket 连接 默认不会出发空闲事件, 默认发超时时间: 1s

Parameters:

host - 监听地址

port - 监听端口

readTimeout - 超时时间, 单位: 毫秒

Throws:

IOException - IO异常

TcpSocket

public TcpSocket(String host,
                 int port,
                 int readTimeout,
                 int idleInterval)
          throws IOException

socket 连接 默认发超时时间: 1s

Parameters:

host - 监听地址

port - 监听端口

idleInterval - 空闲事件触发时间, 单位: 秒

readTimeout - 超时时间, 单位: 毫秒

Throws:

IOException - IO异常

TcpSocket

public TcpSocket(String host,
                 int port,
                 int readTimeout,
                 int sendTimeout,
                 int idleInterval)
          throws IOException

socket 连接

Parameters:

host - 监听地址

port - 监听端口

idleInterval - 空闲事件触发时间, 单位: 秒

readTimeout - 超时时间, 单位: 毫秒

sendTimeout - 发超时时间, 单位: 毫秒

Throws:

IOException - IO异常

TcpSocket

public TcpSocket(SocketContext parentSocketContext,
                 SocketChannel socketChannel)

构造函数

Parameters:

parentSocketContext - 父 SocketChannel 对象

socketChannel - SocketChannel 对象

Method Detail

setIdleInterval

public void setIdleInterval(int idleInterval)

Description copied from class: SocketContext

设置空闲事件时间

Specified by:

setIdleInterval in class SocketContext<SocketChannel,TcpSession>

Parameters:

idleInterval - 空闲事件时间, 单位:秒

setOption

public <T> void setOption(SocketOption<T> name,
                          T value)
                   throws IOException

设置 Socket 的 Option 选项

Specified by:

setOption in class SocketContext<SocketChannel,TcpSession>

Type Parameters:

T - 范型

Parameters:

name - SocketOption类型的枚举, 参照:SocketChannel.setOption的说明

value - SocketOption参数

Throws:

IOException - IO异常

socketChannel

public SocketChannel socketChannel()

获取 SocketChannel 对象

Specified by:

socketChannel in class SocketContext<SocketChannel,TcpSession>

Returns:

SocketChannel 对象

getSession

public TcpSession getSession()

获取 Session 对象

Specified by:

getSession in class SocketContext<SocketChannel,TcpSession>

Returns:

Session 对O象

start

public void start()
           throws IOException

启动同步的上下文连接, 阻塞方法

Specified by:

start in class SocketContext<SocketChannel,TcpSession>

Throws:

IOException - IO 异常

syncStart

public void syncStart()
               throws IOException

启动同步的上下文连接 非阻塞方法

Specified by:

syncStart in class SocketContext<SocketChannel,TcpSession>

Throws:

IOException - IO异常

acceptStart

protected void acceptStart()
                    throws IOException

Description copied from class: SocketContext

用于针对 Accept 进来的 Socket 连接的启动

Specified by:

acceptStart in class SocketContext<SocketChannel,TcpSession>

Throws:

IOException - IO异常

isOpen

public boolean isOpen()

Description copied from class: SocketContext

上下文连接是否打开

Specified by:

isOpen in class SocketContext<SocketChannel,TcpSession>

Returns:

true:连接打开,false:连接关闭

isConnected

public boolean isConnected()

Description copied from class: SocketContext

上下文连接是否连接

Specified by:

isConnected in class SocketContext<SocketChannel,TcpSession>

Returns:

true:连接,false:断开

syncRead

public Object syncRead()
                throws ReadMessageException

同步读取消息

Returns:

读取出的对象

Throws:

ReadMessageException - 读取消息异常

syncSend

public void syncSend(Object obj)
              throws SendMessageException

同步发送消息

Parameters:

obj - 要发送的对象

Throws:

SendMessageException - 消息发送异常

close

public boolean close()

Description copied from class: SocketContext

关闭连接

Specified by:

close in class SocketContext<SocketChannel,TcpSession>

Returns:

是否关闭