io.netty.channel.socket.SocketChannelConfig Maven / Gradle / Ivy
/*
* Copyright 2012 The Netty Project
*
* The Netty 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 io.netty.channel.socket;
import io.netty.buffer.ByteBufAllocator;
import io.netty.channel.ChannelConfig;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandler;
import io.netty.channel.ChannelOption;
import io.netty.channel.MessageSizeEstimator;
import io.netty.channel.RecvByteBufAllocator;
import java.net.Socket;
import java.net.StandardSocketOptions;
/**
* A {@link ChannelConfig} for a {@link SocketChannel}.
*
* Available options
*
* In addition to the options provided by {@link ChannelConfig},
* {@link SocketChannelConfig} allows the following options in the option map:
*
*
*
* Name Associated setter method
*
* {@link ChannelOption#SO_KEEPALIVE} {@link #setKeepAlive(boolean)}
*
* {@link ChannelOption#SO_REUSEADDR} {@link #setReuseAddress(boolean)}
*
* {@link ChannelOption#SO_LINGER} {@link #setSoLinger(int)}
*
* {@link ChannelOption#TCP_NODELAY} {@link #setTcpNoDelay(boolean)}
*
* {@link ChannelOption#SO_RCVBUF} {@link #setReceiveBufferSize(int)}
*
* {@link ChannelOption#SO_SNDBUF} {@link #setSendBufferSize(int)}
*
* {@link ChannelOption#IP_TOS} {@link #setTrafficClass(int)}
*
* {@link ChannelOption#ALLOW_HALF_CLOSURE} {@link #setAllowHalfClosure(boolean)}
*
*
*/
public interface SocketChannelConfig extends ChannelConfig {
/**
* Gets the {@link StandardSocketOptions#TCP_NODELAY} option. Please note that the default value of this option
* is {@code true} unlike the operating system default ({@code false}). However, for some buggy platforms, such as
* Android, that shows erratic behavior with Nagle's algorithm disabled, the default value remains to be
* {@code false}.
*/
boolean isTcpNoDelay();
/**
* Sets the {@link StandardSocketOptions#TCP_NODELAY} option. Please note that the default value of this option
* is {@code true} unlike the operating system default ({@code false}). However, for some buggy platforms, such as
* Android, that shows erratic behavior with Nagle's algorithm disabled, the default value remains to be
* {@code false}.
*/
SocketChannelConfig setTcpNoDelay(boolean tcpNoDelay);
/**
* Gets the {@link StandardSocketOptions#SO_LINGER} option.
*/
int getSoLinger();
/**
* Sets the {@link StandardSocketOptions#SO_LINGER} option.
*/
SocketChannelConfig setSoLinger(int soLinger);
/**
* Gets the {@link StandardSocketOptions#SO_SNDBUF} option.
*/
int getSendBufferSize();
/**
* Sets the {@link StandardSocketOptions#SO_SNDBUF} option.
*/
SocketChannelConfig setSendBufferSize(int sendBufferSize);
/**
* Gets the {@link StandardSocketOptions#SO_RCVBUF} option.
*/
int getReceiveBufferSize();
/**
* Sets the {@link StandardSocketOptions#SO_RCVBUF} option.
*/
SocketChannelConfig setReceiveBufferSize(int receiveBufferSize);
/**
* Gets the {@link StandardSocketOptions#SO_KEEPALIVE} option.
*/
boolean isKeepAlive();
/**
* Sets the {@link StandardSocketOptions#SO_KEEPALIVE} option.
*/
SocketChannelConfig setKeepAlive(boolean keepAlive);
/**
* Gets the {@link StandardSocketOptions#IP_TOS} option.
*/
int getTrafficClass();
/**
* Sets the {@link StandardSocketOptions#IP_TOS} option.
*/
SocketChannelConfig setTrafficClass(int trafficClass);
/**
* Gets the {@link StandardSocketOptions#SO_REUSEADDR} option.
*/
boolean isReuseAddress();
/**
* Sets the {@link StandardSocketOptions#SO_REUSEADDR} option.
*/
SocketChannelConfig setReuseAddress(boolean reuseAddress);
/**
* Sets the performance preferences as specified in
* {@link Socket#setPerformancePreferences(int, int, int)}.
*/
SocketChannelConfig setPerformancePreferences(int connectionTime, int latency, int bandwidth);
/**
* Returns {@code true} if and only if the channel should not close itself when its remote
* peer shuts down output to make the connection half-closed. If {@code false}, the connection
* is closed automatically when the remote peer shuts down output.
*/
boolean isAllowHalfClosure();
/**
* Sets whether the channel should not close itself when its remote peer shuts down output to
* make the connection half-closed. If {@code true} the connection is not closed when the
* remote peer shuts down output. Instead,
* {@link ChannelInboundHandler#userEventTriggered(ChannelHandlerContext, Object)}
* is invoked with a {@link ChannelInputShutdownEvent} object. If {@code false}, the connection
* is closed automatically.
*/
SocketChannelConfig setAllowHalfClosure(boolean allowHalfClosure);
@Override
SocketChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis);
@Override
SocketChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead);
@Override
SocketChannelConfig setWriteSpinCount(int writeSpinCount);
@Override
SocketChannelConfig setAllocator(ByteBufAllocator allocator);
@Override
SocketChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator);
@Override
SocketChannelConfig setAutoRead(boolean autoRead);
@Override
SocketChannelConfig setAutoClose(boolean autoClose);
@Override
SocketChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator);
}