org.apache.mina.transport.socket.SocketSessionConfig Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF 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.apache.mina.transport.socket;
import java.net.Socket;
import org.apache.mina.core.session.IoSessionConfig;
/**
* An {@link IoSessionConfig} for socket transport type.
*
* @author Apache MINA Project
*/
public interface SocketSessionConfig extends IoSessionConfig {
/**
* @see Socket#getReuseAddress()
*
* @return true if SO_REUSEADDR is enabled.
*/
boolean isReuseAddress();
/**
* @see Socket#setReuseAddress(boolean)
*
* @param reuseAddress Tells if SO_REUSEADDR is enabled or disabled
*/
void setReuseAddress(boolean reuseAddress);
/**
* @see Socket#getReceiveBufferSize()
*
* @return the size of the receive buffer
*/
int getReceiveBufferSize();
/**
* @see Socket#setReceiveBufferSize(int)
*
* @param receiveBufferSize The size of the receive buffer
*/
void setReceiveBufferSize(int receiveBufferSize);
/**
* @see Socket#getSendBufferSize()
*
* @return the size of the send buffer
*/
int getSendBufferSize();
/**
* @see Socket#setSendBufferSize(int)
*
* @param sendBufferSize The size of the send buffer
*/
void setSendBufferSize(int sendBufferSize);
/**
* @see Socket#getTrafficClass()
*
* @return the traffic class
*/
int getTrafficClass();
/**
* @see Socket#setTrafficClass(int)
*
* @param trafficClass The traffic class to set, one of IPTOS_LOWCOST (0x02)
* IPTOS_RELIABILITY (0x04), IPTOS_THROUGHPUT (0x08) or IPTOS_LOWDELAY (0x10)
*/
void setTrafficClass(int trafficClass);
/**
* @see Socket#getKeepAlive()
*
* @return true if SO_KEEPALIVE is enabled.
*/
boolean isKeepAlive();
/**
* @see Socket#setKeepAlive(boolean)
*
* @param keepAlive if SO_KEEPALIVE is to be enabled
*/
void setKeepAlive(boolean keepAlive);
/**
* @see Socket#getOOBInline()
*
* @return true if SO_OOBINLINE is enabled.
*/
boolean isOobInline();
/**
* @see Socket#setOOBInline(boolean)
*
* @param oobInline if SO_OOBINLINE is to be enabled
*/
void setOobInline(boolean oobInline);
/**
* Please note that enabling SO_LINGER in Java NIO can result
* in platform-dependent behavior and unexpected blocking of I/O thread.
*
* @see Socket#getSoLinger()
* @see Sun Bug Database
*
* @return The value for SO_LINGER
*/
int getSoLinger();
/**
* Please note that enabling SO_LINGER in Java NIO can result
* in platform-dependent behavior and unexpected blocking of I/O thread.
*
* @param soLinger Please specify a negative value to disable SO_LINGER.
*
* @see Socket#setSoLinger(boolean, int)
* @see Sun Bug Database
*/
void setSoLinger(int soLinger);
/**
* @see Socket#getTcpNoDelay()
*
* @return true if TCP_NODELAY is enabled.
*/
boolean isTcpNoDelay();
/**
* @see Socket#setTcpNoDelay(boolean)
*
* @param tcpNoDelay true if TCP_NODELAY is to be enabled
*/
void setTcpNoDelay(boolean tcpNoDelay);
}