/*
* 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.ChannelOption;
import io.netty.channel.MessageSizeEstimator;
import io.netty.channel.RecvByteBufAllocator;
import io.netty.channel.WriteBufferWaterMark;
import java.net.InetAddress;
import java.net.NetworkInterface;
import java.net.StandardSocketOptions;
A ChannelConfig
for a DatagramChannel
. Available options
In addition to the options provided by ChannelConfig
, DatagramChannelConfig
allows the following options in the option map: /**
* A {@link ChannelConfig} for a {@link DatagramChannel}.
*
* <h3>Available options</h3>
*
* In addition to the options provided by {@link ChannelConfig},
* {@link DatagramChannelConfig} allows the following options in the option map:
*
* <table border="1" cellspacing="0" cellpadding="6">
* <tr>
* <th>Name</th><th>Associated setter method</th>
* </tr><tr>
* <td>{@link ChannelOption#SO_BROADCAST}</td><td>{@link #setBroadcast(boolean)}</td>
* </tr><tr>
* <td>{@link ChannelOption#IP_MULTICAST_ADDR}</td><td>{@link #setInterface(InetAddress)}</td>
* </tr><tr>
* <td>{@link ChannelOption#IP_MULTICAST_LOOP_DISABLED}</td>
* <td>{@link #setLoopbackModeDisabled(boolean)}</td>
* </tr><tr>
* <td>{@link ChannelOption#IP_MULTICAST_IF}</td>
* <td>{@link #setNetworkInterface(NetworkInterface)}</td>
* </tr><tr>
* <td>{@link ChannelOption#SO_REUSEADDR}</td><td>{@link #setReuseAddress(boolean)}</td>
* </tr><tr>
* <td>{@link ChannelOption#SO_RCVBUF}</td><td>{@link #setReceiveBufferSize(int)}</td>
* </tr><tr>
* <td>{@link ChannelOption#SO_SNDBUF}</td><td>{@link #setSendBufferSize(int)}</td>
* </tr><tr>
* <td>{@link ChannelOption#IP_MULTICAST_TTL}</td><td>{@link #setTimeToLive(int)}</td>
* </tr><tr>
* <td>{@link ChannelOption#IP_TOS}</td><td>{@link #setTrafficClass(int)}</td>
* </tr>
* </table>
*/
public interface DatagramChannelConfig extends ChannelConfig {
Gets the StandardSocketOptions.SO_SNDBUF
option. /**
* Gets the {@link StandardSocketOptions#SO_SNDBUF} option.
*/
int getSendBufferSize();
Sets the StandardSocketOptions.SO_SNDBUF
option. /**
* Sets the {@link StandardSocketOptions#SO_SNDBUF} option.
*/
DatagramChannelConfig setSendBufferSize(int sendBufferSize);
Gets the StandardSocketOptions.SO_RCVBUF
option. /**
* Gets the {@link StandardSocketOptions#SO_RCVBUF} option.
*/
int getReceiveBufferSize();
Sets the StandardSocketOptions.SO_RCVBUF
option. /**
* Sets the {@link StandardSocketOptions#SO_RCVBUF} option.
*/
DatagramChannelConfig setReceiveBufferSize(int receiveBufferSize);
Gets the StandardSocketOptions.IP_TOS
option. /**
* Gets the {@link StandardSocketOptions#IP_TOS} option.
*/
int getTrafficClass();
Sets the StandardSocketOptions.IP_TOS
option. /**
* Sets the {@link StandardSocketOptions#IP_TOS} option.
*/
DatagramChannelConfig setTrafficClass(int trafficClass);
Gets the StandardSocketOptions.SO_REUSEADDR
option. /**
* Gets the {@link StandardSocketOptions#SO_REUSEADDR} option.
*/
boolean isReuseAddress();
Gets the StandardSocketOptions.SO_REUSEADDR
option. /**
* Gets the {@link StandardSocketOptions#SO_REUSEADDR} option.
*/
DatagramChannelConfig setReuseAddress(boolean reuseAddress);
Gets the StandardSocketOptions.SO_BROADCAST
option. /**
* Gets the {@link StandardSocketOptions#SO_BROADCAST} option.
*/
boolean isBroadcast();
Sets the StandardSocketOptions.SO_BROADCAST
option. /**
* Sets the {@link StandardSocketOptions#SO_BROADCAST} option.
*/
DatagramChannelConfig setBroadcast(boolean broadcast);
Gets the StandardSocketOptions.IP_MULTICAST_LOOP
option. Returns: true
if and only if the loopback mode has been disabled
/**
* Gets the {@link StandardSocketOptions#IP_MULTICAST_LOOP} option.
*
* @return {@code true} if and only if the loopback mode has been disabled
*/
boolean isLoopbackModeDisabled();
Sets the StandardSocketOptions.IP_MULTICAST_LOOP
option. Params: - loopbackModeDisabled –
true
if and only if the loopback mode has been disabled
/**
* Sets the {@link StandardSocketOptions#IP_MULTICAST_LOOP} option.
*
* @param loopbackModeDisabled
* {@code true} if and only if the loopback mode has been disabled
*/
DatagramChannelConfig setLoopbackModeDisabled(boolean loopbackModeDisabled);
Gets the StandardSocketOptions.IP_MULTICAST_TTL
option. /**
* Gets the {@link StandardSocketOptions#IP_MULTICAST_TTL} option.
*/
int getTimeToLive();
Sets the StandardSocketOptions.IP_MULTICAST_TTL
option. /**
* Sets the {@link StandardSocketOptions#IP_MULTICAST_TTL} option.
*/
DatagramChannelConfig setTimeToLive(int ttl);
Gets the address of the network interface used for multicast packets.
/**
* Gets the address of the network interface used for multicast packets.
*/
InetAddress getInterface();
Sets the address of the network interface used for multicast packets.
/**
* Sets the address of the network interface used for multicast packets.
*/
DatagramChannelConfig setInterface(InetAddress interfaceAddress);
Gets the StandardSocketOptions.IP_MULTICAST_IF
option. /**
* Gets the {@link StandardSocketOptions#IP_MULTICAST_IF} option.
*/
NetworkInterface getNetworkInterface();
Sets the StandardSocketOptions.IP_MULTICAST_IF
option. /**
* Sets the {@link StandardSocketOptions#IP_MULTICAST_IF} option.
*/
DatagramChannelConfig setNetworkInterface(NetworkInterface networkInterface);
@Override
@Deprecated
DatagramChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead);
@Override
DatagramChannelConfig setWriteSpinCount(int writeSpinCount);
@Override
DatagramChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis);
@Override
DatagramChannelConfig setAllocator(ByteBufAllocator allocator);
@Override
DatagramChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator);
@Override
DatagramChannelConfig setAutoRead(boolean autoRead);
@Override
DatagramChannelConfig setAutoClose(boolean autoClose);
@Override
DatagramChannelConfig setMessageSizeEstimator(MessageSizeEstimator estimator);
@Override
DatagramChannelConfig setWriteBufferWaterMark(WriteBufferWaterMark writeBufferWaterMark);
}