Module bus.socket

Package org.miaixz.bus.socket.accord

Class TcpSession

java.lang.Object

org.miaixz.bus.socket.Session

org.miaixz.bus.socket.accord.TcpSession

public class TcpSession
extends Session

AIO传输层会话

Session为最核心的类，封装AsynchronousSocketChannel API接口，简化IO操作。

其中开放给用户使用的接口为：

1. Session.close()
2. close(boolean)
3. Session.getAttachment()
4. getInputStream()
5. getInputStream(int)
6. getLocalAddress()
7. getRemoteAddress()
8. Session.getSessionID()
9. Session.isInvalid()
10. Session.setAttachment(Object)

Since:

Java 17+

Author:

Kimi Liu

Field Summary

Fields inherited from class org.miaixz.bus.socket.Session

eof, modCount, SESSION_STATUS_CLOSED, SESSION_STATUS_CLOSING, SESSION_STATUS_ENABLED, status

Constructor Summary

Constructors

Constructor	Description
TcpSession(AsynchronousSocketChannel channel, Context context, BufferPage writeBufferPage, Supplier<VirtualBuffer> readBufferSupplier)

Method Summary

Modifier and Type	Method	Description
void	awaitRead()
void	close(boolean immediate)	是否立即关闭会话
InputStream	getInputStream()	获得数据输入流对象。
InputStream	getInputStream(int length)	获取已知长度的InputStream
InetSocketAddress	getLocalAddress()	获取当前会话的本地连接地址
InetSocketAddress	getRemoteAddress()	获取当前会话的远程连接地址
ByteBuffer	readBuffer()	获取读缓冲区对象
void	signalRead()	触发通道的读回调操作
WriteBuffer	writeBuffer()	获取WriteBuffer用以数据输出

Methods inherited from class org.miaixz.bus.socket.Session

close, getAttachment, getSessionID, isInvalid, setAttachment

Methods inherited from class java.lang.Object

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

Constructor Details

TcpSession

public TcpSession(AsynchronousSocketChannel channel,
 Context context,
 BufferPage writeBufferPage,
 Supplier<VirtualBuffer> readBufferSupplier)

Parameters:

channel - Socket通道

Method Details

close

public void close(boolean immediate)

是否立即关闭会话

Specified by:

close in class Session

Parameters:

immediate - true:立即关闭,false:响应消息发送完后关闭

writeBuffer

public WriteBuffer writeBuffer()

Description copied from class: Session

获取WriteBuffer用以数据输出

Specified by:

writeBuffer in class Session

Returns:

输入流

readBuffer

public ByteBuffer readBuffer()

Description copied from class: Session

获取读缓冲区对象

Specified by:

readBuffer in class Session

awaitRead

public void awaitRead()

Specified by:

awaitRead in class Session

signalRead

public void signalRead()

触发通道的读回调操作

Specified by:

signalRead in class Session

getLocalAddress

public InetSocketAddress getLocalAddress()
                                  throws IOException

Description copied from class: Session

获取当前会话的本地连接地址

Specified by:

getLocalAddress in class Session

Returns:

本地地址

Throws:

IOException - IO异常

See Also:

• AsynchronousSocketChannel.getLocalAddress()

getRemoteAddress

public InetSocketAddress getRemoteAddress()
                                   throws IOException

Description copied from class: Session

获取当前会话的远程连接地址

Specified by:

getRemoteAddress in class Session

Returns:

远程地址

Throws:

IOException - IO异常

See Also:

• AsynchronousSocketChannel.getRemoteAddress()

getInputStream

public InputStream getInputStream()
                           throws IOException

获得数据输入流对象。

faster模式下调用该方法会触发UnsupportedOperationException异常。 Handler采用异步处理消息的方式时，调用该方法可能会出现异常。

Overrides:

getInputStream in class Session

Returns:

同步读操作的流对象

Throws:

IOException - io异常

getInputStream

public InputStream getInputStream(int length)
                           throws IOException

获取已知长度的InputStream

Overrides:

getInputStream in class Session

Parameters:

length - InputStream长度

Returns:

同步读操作的流对象

Throws:

IOException - io异常