151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 23a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved. 351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.net; 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 283a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kongimport java.lang.annotation.Native; 293a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong 3051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Interface of methods to get/set socket options. This interface is 3251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implemented by: <B>SocketImpl</B> and <B>DatagramSocketImpl</B>. 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Subclasses of these should override the methods 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of this interface in order to support their own options. 3551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 3651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The methods and constants which specify options in this interface are 3751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for implementation only. If you're not subclassing SocketImpl or 3851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DatagramSocketImpl, <B>you won't use these directly.</B> There are 3951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * type-safe methods to get/set each of these options in Socket, ServerSocket, 4051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DatagramSocket and MulticastSocket. 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 4251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @author David Brown 4351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 4551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 4651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic interface SocketOptions { 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 4851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 4951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Enable/disable the option specified by <I>optID</I>. If the option 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is to be enabled, and it takes an option-specific "value", this is 5151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * passed in <I>value</I>. The actual type of value is option-specific, 5251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and it is an error to pass something that isn't of the expected type: 5351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <BR><PRE> 5451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * SocketImpl s; 5551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ... 5651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * s.setOption(SO_LINGER, new Integer(10)); 5751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // OK - set SO_LINGER w/ timeout of 10 sec. 5851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * s.setOption(SO_LINGER, new Double(10)); 5951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // ERROR - expects java.lang.Integer 6051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski *</PRE> 6151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the requested option is binary, it can be set using this method by 6251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a java.lang.Boolean: 6351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <BR><PRE> 6451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * s.setOption(TCP_NODELAY, new Boolean(true)); 6551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // OK - enables TCP_NODELAY, a binary option 6651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </PRE> 6751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <BR> 6851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Any option can be disabled using this method with a Boolean(false): 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <BR><PRE> 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * s.setOption(TCP_NODELAY, new Boolean(false)); 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // OK - disables TCP_NODELAY 7251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * s.setOption(SO_LINGER, new Boolean(false)); 7351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // OK - disables SO_LINGER 7451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </PRE> 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <BR> 7651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * For an option that has a notion of on and off, and requires 7751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a non-boolean parameter, setting its value to anything other than 7851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <I>Boolean(false)</I> implicitly enables it. 7951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <BR> 8051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Throws SocketException if the option is unrecognized, 8151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the socket is closed, or some low-level error occurred 8251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <BR> 8351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param optID identifies the option 8451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param value the parameter of the socket option 8551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws SocketException if the option is unrecognized, 8651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the socket is closed, or some low-level error occurred 8751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #getOption(int) 8851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 8951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void 9051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski setOption(int optID, Object value) throws SocketException; 9151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 9251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 9351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Fetch the value of an option. 9451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Binary options will return java.lang.Boolean(true) 9551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if enabled, java.lang.Boolean(false) if disabled, e.g.: 9651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <BR><PRE> 9751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * SocketImpl s; 9851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ... 9951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Boolean noDelay = (Boolean)(s.getOption(TCP_NODELAY)); 10051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (noDelay.booleanValue()) { 10151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // true if TCP_NODELAY is enabled... 10251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ... 10351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 10451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </PRE> 10551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 10651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * For options that take a particular type as a parameter, 10751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * getOption(int) will return the parameter's value, else 10851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it will return java.lang.Boolean(false): 10951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <PRE> 11051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Object o = s.getOption(SO_LINGER); 11151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if (o instanceof Integer) { 11251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * System.out.print("Linger time is " + ((Integer)o).intValue()); 11351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } else { 11451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * // the true type of o is java.lang.Boolean(false); 11551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * } 11651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </PRE> 11751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1183a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong * @param optID an {@code int} identifying the option to fetch 11951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the value of the option 12051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws SocketException if the socket is closed 12151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws SocketException if <I>optID</I> is unknown along the 12251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * protocol stack (including the SocketImpl) 12351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #setOption(int, java.lang.Object) 12451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 12551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Object getOption(int optID) throws SocketException; 12651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 12751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 12851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The java-supported BSD-style options. 12951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 13051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 13151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 13251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Disable Nagle's algorithm for this connection. Written data 13351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to the network is not buffered pending acknowledgement of 13451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * previously written data. 13551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski *<P> 13651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Valid for TCP only: SocketImpl. 1373a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong * 13851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#setTcpNoDelay 13951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#getTcpNoDelay 14051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 14151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 1423a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int TCP_NODELAY = 0x0001; 14351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 14451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 14551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Fetch the local address binding of a socket (this option cannot 14651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * be "set" only "gotten", since sockets are bound at creation time, 14751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and so the locally bound address cannot be changed). The default local 14851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * address of a socket is INADDR_ANY, meaning any local address on a 14951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * multi-homed host. A multi-homed host can use this option to accept 15051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * connections to only one of its addresses (in the case of a 15151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ServerSocket or DatagramSocket), or to specify its return address 15251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to the peer (for a Socket or DatagramSocket). The parameter of 15351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this option is an InetAddress. 15451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 15551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This option <B>must</B> be specified in the constructor. 15651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 15751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Valid for: SocketImpl, DatagramSocketImpl 1583a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong * 15951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#getLocalAddress 16051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see DatagramSocket#getLocalAddress 16151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 16251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 1633a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int SO_BINDADDR = 0x000F; 16451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 16551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** Sets SO_REUSEADDR for a socket. This is used only for MulticastSockets 16651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in java, and it is set by default for MulticastSockets. 16751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 16851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Valid for: DatagramSocketImpl 16951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 17051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 1713a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int SO_REUSEADDR = 0x04; 17251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 17351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 17451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Sets SO_BROADCAST for a socket. This option enables and disables 17551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the ability of the process to send broadcast messages. It is supported 17651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for only datagram sockets and only on networks that support 17751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the concept of a broadcast message (e.g. Ethernet, token ring, etc.), 17851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and it is set by default for DatagramSockets. 17951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.4 18051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 18151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 1823a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int SO_BROADCAST = 0x0020; 18351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 18451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** Set which outgoing interface on which to send multicast packets. 18551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Useful on hosts with multiple network interfaces, where applications 18651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * want to use other than the system default. Takes/returns an InetAddress. 18751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 18851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Valid for Multicast: DatagramSocketImpl 1893a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong * 19051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see MulticastSocket#setInterface(InetAddress) 19151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see MulticastSocket#getInterface() 19251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 19351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 1943a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int IP_MULTICAST_IF = 0x10; 19551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 19651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** Same as above. This option is introduced so that the behaviour 19751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with IP_MULTICAST_IF will be kept the same as before, while 19851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this new option can support setting outgoing interfaces with either 19951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * IPv4 and IPv6 addresses. 20051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 20151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * NOTE: make sure there is no conflict with this 20251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see MulticastSocket#setNetworkInterface(NetworkInterface) 20351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see MulticastSocket#getNetworkInterface() 20451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.4 20551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2063a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int IP_MULTICAST_IF2 = 0x1f; 20751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 20851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 20951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This option enables or disables local loopback of multicast datagrams. 21051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This option is enabled by default for Multicast Sockets. 21151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.4 21251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 21351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2143a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int IP_MULTICAST_LOOP = 0x12; 21551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 21651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 21751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This option sets the type-of-service or traffic class field 21851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in the IP header for a TCP or UDP socket. 21951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.4 22051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 22151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2223a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int IP_TOS = 0x3; 22351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 22451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 22551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Specify a linger-on-close timeout. This option disables/enables 22651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * immediate return from a <B>close()</B> of a TCP Socket. Enabling 22751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this option with a non-zero Integer <I>timeout</I> means that a 22851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <B>close()</B> will block pending the transmission and acknowledgement 22951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of all data written to the peer, at which point the socket is closed 23051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <I>gracefully</I>. Upon reaching the linger timeout, the socket is 23151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * closed <I>forcefully</I>, with a TCP RST. Enabling the option with a 23251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * timeout of zero does a forceful close immediately. If the specified 23351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * timeout value exceeds 65,535 it will be reduced to 65,535. 23451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> 23551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Valid only for TCP: SocketImpl 23651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 23751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#setSoLinger 23851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#getSoLinger 23951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2403a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int SO_LINGER = 0x0080; 24151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 24251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** Set a timeout on blocking Socket operations: 24351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <PRE> 24451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ServerSocket.accept(); 24551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * SocketInputStream.read(); 24651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DatagramSocket.receive(); 24751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * </PRE> 24851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 24951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> The option must be set prior to entering a blocking 25051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * operation to take effect. If the timeout expires and the 25151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * operation would continue to block, 25251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <B>java.io.InterruptedIOException</B> is raised. The Socket is 25351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * not closed in this case. 25451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 25551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <P> Valid for all sockets: SocketImpl, DatagramSocketImpl 25651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 25751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#setSoTimeout 25851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see ServerSocket#setSoTimeout 25951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see DatagramSocket#setSoTimeout 26051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2613a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int SO_TIMEOUT = 0x1006; 26251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 26351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 26451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Set a hint the size of the underlying buffers used by the 26551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * platform for outgoing network I/O. When used in set, this is a 26651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * suggestion to the kernel from the application about the size of 26751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * buffers to use for the data to be sent over the socket. When 26851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * used in get, this must return the size of the buffer actually 26951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * used by the platform when sending out data on this socket. 27051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 27151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Valid for all sockets: SocketImpl, DatagramSocketImpl 27251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 27351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#setSendBufferSize 27451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#getSendBufferSize 27551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see DatagramSocket#setSendBufferSize 27651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see DatagramSocket#getSendBufferSize 27751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2783a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int SO_SNDBUF = 0x1001; 27951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 28051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 28151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Set a hint the size of the underlying buffers used by the 28251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * platform for incoming network I/O. When used in set, this is a 28351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * suggestion to the kernel from the application about the size of 28451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * buffers to use for the data to be received over the 28551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * socket. When used in get, this must return the size of the 28651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * buffer actually used by the platform when receiving in data on 28751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this socket. 28851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 28951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Valid for all sockets: SocketImpl, DatagramSocketImpl 29051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 29151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#setReceiveBufferSize 29251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#getReceiveBufferSize 29351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see DatagramSocket#setReceiveBufferSize 29451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see DatagramSocket#getReceiveBufferSize 29551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2963a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int SO_RCVBUF = 0x1002; 29751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 29851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 29951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * When the keepalive option is set for a TCP socket and no data 30051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * has been exchanged across the socket in either direction for 30151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 hours (NOTE: the actual value is implementation dependent), 30251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * TCP automatically sends a keepalive probe to the peer. This probe is a 30351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * TCP segment to which the peer must respond. 30451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * One of three responses is expected: 30551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1. The peer responds with the expected ACK. The application is not 30651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * notified (since everything is OK). TCP will send another probe 30751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * following another 2 hours of inactivity. 30851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2. The peer responds with an RST, which tells the local TCP that 30951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the peer host has crashed and rebooted. The socket is closed. 31051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 3. There is no response from the peer. The socket is closed. 31151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 31251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The purpose of this option is to detect if the peer host crashes. 31351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 31451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Valid only for TCP socket: SocketImpl 31551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 31651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#setKeepAlive 31751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#getKeepAlive 31851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 3193a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int SO_KEEPALIVE = 0x0008; 32051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 32151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 32251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * When the OOBINLINE option is set, any TCP urgent data received on 32351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the socket will be received through the socket input stream. 32451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * When the option is disabled (which is the default) urgent data 32551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is silently discarded. 32651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 32751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#setOOBInline 32851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Socket#getOOBInline 32951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 3303a6411ec91b24e73f36301d0075bc7b052894ae9Yi Kong @Native public final static int SO_OOBINLINE = 0x1003; 33151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 332