org.jboss.netty.channel.socket.SocketChannelConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hello-world-plugin Show documentation
Show all versions of hello-world-plugin Show documentation
Kill Bill Hello World plugin
The newest version!
/*
* 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 org.jboss.netty.channel.socket;
import java.net.Socket;
import java.net.StandardSocketOptions;
import org.jboss.netty.channel.ChannelConfig;
/**
* 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
*
* {@code "keepAlive"} {@link #setKeepAlive(boolean)}
*
* {@code "reuseAddress"} {@link #setReuseAddress(boolean)}
*
* {@code "soLinger"} {@link #setSoLinger(int)}
*
* {@code "tcpNoDelay"} {@link #setTcpNoDelay(boolean)}
*
* {@code "receiveBufferSize"} {@link #setReceiveBufferSize(int)}
*
* {@code "sendBufferSize"} {@link #setSendBufferSize(int)}
*
* {@code "trafficClass"} {@link #setTrafficClass(int)}
*
*
*/
public interface SocketChannelConfig extends ChannelConfig {
/**
* Gets the {@link StandardSocketOptions#TCP_NODELAY} option.
*/
boolean isTcpNoDelay();
/**
* Sets the {@link StandardSocketOptions#TCP_NODELAY} option.
*/
void setTcpNoDelay(boolean tcpNoDelay);
/**
* Gets the {@link StandardSocketOptions#SO_LINGER} option.
*/
int getSoLinger();
/**
* Sets the {@link StandardSocketOptions#SO_LINGER} option.
*/
void setSoLinger(int soLinger);
/**
* Gets the {@link StandardSocketOptions#SO_SNDBUF} option.
*/
int getSendBufferSize();
/**
* Sets the {@link StandardSocketOptions#SO_SNDBUF} option.
*/
void setSendBufferSize(int sendBufferSize);
/**
* Gets the {@link StandardSocketOptions#SO_RCVBUF} option.
*/
int getReceiveBufferSize();
/**
* Sets the {@link StandardSocketOptions#SO_RCVBUF} option.
*/
void setReceiveBufferSize(int receiveBufferSize);
/**
* Gets the {@link StandardSocketOptions#SO_KEEPALIVE} option.
*/
boolean isKeepAlive();
/**
* Sets the {@link StandardSocketOptions#SO_KEEPALIVE} option.
*/
void setKeepAlive(boolean keepAlive);
/**
* Gets the {@link StandardSocketOptions#IP_TOS} option.
*/
int getTrafficClass();
/**
* Sets the {@link StandardSocketOptions#IP_TOS} option.
*/
void setTrafficClass(int trafficClass);
/**
* Gets the {@link StandardSocketOptions#SO_REUSEADDR} option.
*/
boolean isReuseAddress();
/**
* Sets the {@link StandardSocketOptions#SO_REUSEADDR} option.
*/
void setReuseAddress(boolean reuseAddress);
/**
* Sets the performance preferences as specified in
* {@link Socket#setPerformancePreferences(int, int, int)}.
*/
void setPerformancePreferences(
int connectionTime, int latency, int bandwidth);
}