qcloud.storage.ranger.thirdparty.org.jboss.netty.channel.socket.DatagramChannelConfig 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 qcloud.storage.ranger.thirdparty.org.jboss.netty.channel.socket;
import java.net.InetAddress;
import java.net.NetworkInterface;
import java.net.StandardSocketOptions;
import qcloud.storage.ranger.thirdparty.org.jboss.netty.channel.ChannelConfig;
import qcloud.storage.ranger.thirdparty.org.jboss.netty.channel.FixedReceiveBufferSizePredictor;
import qcloud.storage.ranger.thirdparty.org.jboss.netty.channel.FixedReceiveBufferSizePredictorFactory;
import qcloud.storage.ranger.thirdparty.org.jboss.netty.channel.ReceiveBufferSizePredictor;
import qcloud.storage.ranger.thirdparty.org.jboss.netty.channel.ReceiveBufferSizePredictorFactory;
/**
* A {@link ChannelConfig} for a {@link DatagramChannel}.
*
* Available options
*
* In addition to the options provided by {@link ChannelConfig},
* {@link DatagramChannelConfig} allows the following options in the option map:
*
*
*
* Name Associated setter method
*
* {@code "broadcast"} {@link #setBroadcast(boolean)}
*
* {@code "interface"} {@link #setInterface(InetAddress)}
*
* {@code "loopbackModeDisabled"} {@link #setLoopbackModeDisabled(boolean)}
*
* {@code "networkInterface"} {@link #setNetworkInterface(NetworkInterface)}
*
* {@code "reuseAddress"} {@link #setReuseAddress(boolean)}
*
* {@code "receiveBufferSize"} {@link #setReceiveBufferSize(int)}
*
* {@code "receiveBufferSizePredictor"}
* {@link #setReceiveBufferSizePredictor(ReceiveBufferSizePredictor)}
*
* {@code "receiveBufferSizePredictorFactory"}
* {@link #setReceiveBufferSizePredictorFactory(ReceiveBufferSizePredictorFactory)}
*
* {@code "sendBufferSize"} {@link #setSendBufferSize(int)}
*
* {@code "timeToLive"} {@link #setTimeToLive(int)}
*
* {@code "trafficClass"} {@link #setTrafficClass(int)}
*
*
*/
public interface DatagramChannelConfig extends ChannelConfig {
/**
* 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#IP_TOS} option.
*/
int getTrafficClass();
/**
* Gets 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);
/**
* Gets the {@link StandardSocketOptions#SO_BROADCAST} option.
*/
boolean isBroadcast();
/**
* Sets the {@link StandardSocketOptions#SO_BROADCAST} option.
*/
void setBroadcast(boolean broadcast);
/**
* Gets the {@link StandardSocketOptions#IP_MULTICAST_LOOP} option.
*/
boolean isLoopbackModeDisabled();
/**
* Sets the {@link StandardSocketOptions#IP_MULTICAST_LOOP} option.
*
* @param loopbackModeDisabled
* {@code true} if and only if the loopback mode has been disabled
*/
void setLoopbackModeDisabled(boolean loopbackModeDisabled);
/**
* Gets the {@link StandardSocketOptions#IP_MULTICAST_TTL} option.
*/
int getTimeToLive();
/**
* Sets the {@link StandardSocketOptions#IP_MULTICAST_TTL} option.
*/
void setTimeToLive(int ttl);
/**
* Gets the address of the network interface used for multicast packets.
*/
InetAddress getInterface();
/**
* Sets the address of the network interface used for multicast packets.
*/
void setInterface(InetAddress interfaceAddress);
/**
* Gets the {@link StandardSocketOptions#IP_MULTICAST_IF} option.
*/
NetworkInterface getNetworkInterface();
/**
* Sets the {@link StandardSocketOptions#IP_MULTICAST_IF} option.
*/
void setNetworkInterface(NetworkInterface networkInterface);
/**
* Returns the {@link ReceiveBufferSizePredictor} which predicts the
* number of readable bytes in the socket receive buffer. The default
* predictor is {@link FixedReceiveBufferSizePredictor}(768).
*/
ReceiveBufferSizePredictor getReceiveBufferSizePredictor();
/**
* Sets the {@link ReceiveBufferSizePredictor} which predicts the
* number of readable bytes in the socket receive buffer. The default
* predictor is {@link FixedReceiveBufferSizePredictor}(768).
*/
void setReceiveBufferSizePredictor(ReceiveBufferSizePredictor predictor);
/**
* Returns the {@link ReceiveBufferSizePredictorFactory} which creates a new
* {@link ReceiveBufferSizePredictor} when a new channel is created and
* no {@link ReceiveBufferSizePredictor} was set. If no predictor was set
* for the channel, {@link #setReceiveBufferSizePredictor(ReceiveBufferSizePredictor)}
* will be called with the new predictor. The default factory is
* {@link FixedReceiveBufferSizePredictorFactory}(768).
*/
ReceiveBufferSizePredictorFactory getReceiveBufferSizePredictorFactory();
/**
* Sets the {@link ReceiveBufferSizePredictor} which creates a new
* {@link ReceiveBufferSizePredictor} when a new channel is created and
* no {@link ReceiveBufferSizePredictor} was set. If no predictor was set
* for the channel, {@link #setReceiveBufferSizePredictor(ReceiveBufferSizePredictor)}
* will be called with the new predictor. The default factory is
* {@link FixedReceiveBufferSizePredictorFactory}(768).
*/
void setReceiveBufferSizePredictorFactory(ReceiveBufferSizePredictorFactory predictorFactory);
}