org.dromara.hutool.socket.aio.AioSession Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dromara.hutool.socket.aio;
import org.dromara.hutool.core.io.IORuntimeException;
import org.dromara.hutool.core.io.IoUtil;
import org.dromara.hutool.socket.SocketConfig;
import org.dromara.hutool.socket.SocketUtil;
import java.io.Closeable;
import java.io.IOException;
import java.net.SocketAddress;
import java.nio.ByteBuffer;
import java.nio.channels.AsynchronousSocketChannel;
import java.nio.channels.CompletionHandler;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
/**
* AIO会话
* 每个客户端对应一个会话对象
*
* @author looly
*
*/
public class AioSession implements Closeable{
private static final ReadHandler READ_HANDLER = new ReadHandler();
private final AsynchronousSocketChannel channel;
private final IoAction ioAction;
private ByteBuffer readBuffer;
private ByteBuffer writeBuffer;
/** 读取超时时长，小于等于0表示默认 */
private final long readTimeout;
/** 写出超时时长，小于等于0表示默认 */
private final long writeTimeout;
/**
* 构造
*
* @param channel {@link AsynchronousSocketChannel}
* @param ioAction IO消息处理类
* @param config 配置项
*/
public AioSession(final AsynchronousSocketChannel channel, final IoAction ioAction, final SocketConfig config) {
this.channel = channel;
this.ioAction = ioAction;
this.readBuffer = ByteBuffer.allocate(config.getReadBufferSize());
this.writeBuffer = ByteBuffer.allocate(config.getWriteBufferSize());
this.readTimeout = config.getReadTimeout();
this.writeTimeout = config.getWriteTimeout();
}
/**
* 获取{@link AsynchronousSocketChannel}
*
* @return {@link AsynchronousSocketChannel}
*/
public AsynchronousSocketChannel getChannel() {
return this.channel;
}
/**
* 获取读取Buffer
*
* @return 读取Buffer
*/
public ByteBuffer getReadBuffer() {
return this.readBuffer;
}
/**
* 获取写Buffer
*
* @return 写Buffer
*/
public ByteBuffer getWriteBuffer() {
return this.writeBuffer;
}
/**
* 获取消息处理器
*
* @return {@link IoAction}
*/
public IoAction getIoAction() {
return this.ioAction;
}
/**
* 获取远程主机（客户端）地址和端口
*
* @return 远程主机（客户端）地址和端口
*/
public SocketAddress getRemoteAddress() {
return SocketUtil.getRemoteAddress(this.channel);
}
/**
* 读取数据到Buffer
*
* @return this
*/
public AioSession read() {
return read(READ_HANDLER);
}
/**
* 读取数据到Buffer
*
* @param handler {@link CompletionHandler}
* @return this
*/
public AioSession read(final CompletionHandler handler) {
if (isOpen()) {
this.readBuffer.clear();
this.channel.read(this.readBuffer, Math.max(this.readTimeout, 0L), TimeUnit.MILLISECONDS, this, handler);
}
return this;
}
/**
* 写数据到目标端，并关闭输出
*
* @param data 数据
* @return this
*/
public AioSession writeAndClose(final ByteBuffer data) {
write(data);
return closeOut();
}
/**
* 写数据到目标端
*
* @param data 数据
* @return {@link Future}
*/
public Future write(final ByteBuffer data) {
return this.channel.write(data);
}
/**
* 写数据到目标端
*
* @param data 数据
* @param handler {@link CompletionHandler}
* @return this
*/
public AioSession write(final ByteBuffer data, final CompletionHandler handler) {
this.channel.write(data, Math.max(this.writeTimeout, 0L), TimeUnit.MILLISECONDS, this, handler);
return this;
}
/**
* 会话是否打开状态
* 当Socket保持连接时会话始终打开
*
* @return 会话是否打开状态
*/
public boolean isOpen() {
return (null != this.channel) && this.channel.isOpen();
}
/**
* 关闭输出
*
* @return this
*/
public AioSession closeIn() {
if (null != this.channel) {
try {
this.channel.shutdownInput();
} catch (final IOException e) {
throw new IORuntimeException(e);
}
}
return this;
}
/**
* 关闭输出
*
* @return this
*/
public AioSession closeOut() {
if (null != this.channel) {
try {
this.channel.shutdownOutput();
} catch (final IOException e) {
throw new IORuntimeException(e);
}
}
return this;
}
/**
* 关闭会话
*/
@Override
public void close() {
IoUtil.closeQuietly(this.channel);
this.readBuffer = null;
this.writeBuffer = null;
}
/**
* 执行读，用于读取事件结束的回调
*/
protected void callbackRead() {
readBuffer.flip();// 读模式
ioAction.doAction(this, readBuffer);
}
}