All Downloads are FREE. Search and download functionalities are using the official Maven repository.

cn.starboot.socket.plugins.SocketOptionPlugin Maven / Gradle / Ivy

There is a newer version: 2.0.4
Show newest version
/*
 *    Copyright 2019 The aio-socket Project
 *
 *    The aio-socket Project Licenses this file to you 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 cn.starboot.socket.plugins;

import cn.starboot.socket.core.AioConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.IOException;
import java.net.SocketOption;
import java.net.StandardSocketOptions;
import java.nio.channels.AsynchronousSocketChannel;
import java.util.HashMap;
import java.util.Map;

/**
 * 用于设置Socket Option的插件
 *
 * @author MDong
 * @version 2.10.1.v20211002-RELEASE
 */
public class SocketOptionPlugin extends AbstractPlugin {

    private static final Logger LOGGER = LoggerFactory.getLogger(ReconnectPlugin.class);

    private final Map, Object> optionMap = new HashMap<>();

    public SocketOptionPlugin() {
        if (LOGGER.isInfoEnabled()) {
            LOGGER.info("aio-socket version: " + AioConfig.VERSION + "; server kernel's stream socket option plugin added successfully");
        }
    }

    @Override
    public final AsynchronousSocketChannel shouldAccept(AsynchronousSocketChannel channel) {
        setOption(channel);
        return super.shouldAccept(channel);
    }

    /**
     * 往socket channel中设置option值。
     * 默认将通过{@link #setOption(SocketOption, Object)}指定的配置值绑定到每一个Socket中。
     * 如果有个性化的需求,可以重新实现本方法。
     *
     * @param channel .
     */
    public void setOption(AsynchronousSocketChannel channel) {
        try {
            if (!optionMap.containsKey(StandardSocketOptions.TCP_NODELAY)) {
                channel.setOption(StandardSocketOptions.TCP_NODELAY, true);
            }
            for (Map.Entry, Object> entry : optionMap.entrySet()) {
                channel.setOption(entry.getKey(), entry.getValue());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 设置Socket的TCP参数配置。
     * 

* AIO客户端的有效可选范围为: * 1. StandardSocketOptions.SO_SNDBUF * 2. StandardSocketOptions.SO_RCVBUF * 3. StandardSocketOptions.SO_KEEPALIVE * 4. StandardSocketOptions.SO_REUSEADDR * 5. StandardSocketOptions.TCP_NODELAY *

* * @param socketOption 配置项 * @param value 配置值 * @return . */ public final SocketOptionPlugin setOption(SocketOption socketOption, Object value) { put0(socketOption, value); return this; } public final Object getOption(SocketOption socketOption) { return optionMap.get(socketOption); } private void put0(SocketOption socketOption, Object value) { optionMap.put(socketOption, value); } }