java.net
인터페이스 SocketOptions

기존의 구현 클래스의 일람:

DatagramSocketImpl , SocketImpl

public interface SocketOptions

소켓의 옵션을 취득 또는 설정하는 메소드의 인터페이스입니다. 이 인터페이스는 SocketImpl 및 DatagramSocketImpl 에 의해 구현됩니다. 이러한 서브 클래스에서 독자적인 옵션을 서포트하려면 , 이 인터페이스의 메소드를 오버라이드(override) 해 주세요.

이 인터페이스로 옵션을 지정하고 있는 메소드와 정수는 구현을 위해만의 것입니다. SocketImpl 또는 DatagramSocketImpl 를 서브 클래스화하지 않는 경우는 이것들을 직접 사용하지 말아 주세요. Socket, ServerSocket, DatagramSocket, 및 MulticastSocket 내의 각각의 옵션을 취득 및 설정하기 위한 , 형태에 대해서 안전한 메소드가 있으므로 그것을 사용합니다.

필드의 개요

static int	IP_MULTICAST_IF 멀티 캐스트 패킷을 송신하는 송출 인터페이스를 어느 것으로 하는지 설정합니다.
static int	IP_MULTICAST_IF2 상기와 같습니다.
static int	IP_MULTICAST_LOOP 이 옵션은 멀티 캐스트 데이터 그램의 로컬 루프백을 유효 또는 무효로 합니다.
static int	IP_TOS 이 옵션은 TCP 또는 UDP 소켓의 IP 헤더의 서비스 타입 또는 트래픽 클래스 필드를 설정합니다.
static int	SO_BINDADDR 소켓의 로컬 주소에의 바인드를 취득합니다.
static int	SO_BROADCAST 소켓의 SO_BROADCAST 를 설정합니다.
static int	SO_KEEPALIVE TCP 소켓에 KeepAlive 옵션이 설정되어 있어, 소켓을 개입시켜 어느 방향에도 데이터가 2 시간 (주: 실제의 값은 구현에 의한다)의 사이 교환되어 있지 않은 경우, TCP 는 자동적으로 KeepAlive 프로브를 피어에 송신합니다.
static int	SO_LINGER linger-on-close 타임 아웃을 지정합니다.
static int	SO_OOBINLINE OOBINLINE 옵션이 설정되어 있으면(자), 소켓으로 수신되는 TCP 긴급 데이터는 모두 소켓 입력 스트림을 경유해 수신됩니다.
static int	SO_RCVBUF 수신 네트워크 입출력용으로서 플랫폼에서 사용되는 버퍼의 사이즈의 힌트를 설정합니다.
static int	SO_REUSEADDR 소켓의 SO_REUSEADDR 를 설정합니다.
static int	SO_SNDBUF 송신 네트워크 입출력용으로서 플랫폼에서 사용되는 버퍼의 사이즈의 힌트를 설정합니다.
static int	SO_TIMEOUT 소켓 조작의 블록에 타임 아웃을 설정합니다.
static int	TCP_NODELAY 이 접속에 사용하는 Nagle 의 알고리즘을 무효로 합니다.

메소드의 개요

Object	getOption (int optID) 옵션의 값을 취득합니다.
void	setOption (int optID, Object value) optID 로 지정된 옵션을 유효 또는 무효로 합니다.

필드의 상세

TCP_NODELAY

public static final int TCP_NODELAY

이 접속에 사용하는 Nagle 의 알고리즘을 무효로 합니다. 이전에 기입해진 데이터가 승인될 때까지 네트워크에 기입해지는 데이터는 버퍼에 저장되지 않습니다.

TCP 인 만큼 유효: SocketImpl

관련 항목:

Socket.setTcpNoDelay(boolean) , Socket.getTcpNoDelay() , 정수 필드치

SO_BINDADDR

public static final int SO_BINDADDR

소켓의 로컬 주소에의 바인드를 취득합니다. 이 옵션은 취득되는 것만으로, 설정은 할 수 없습니다. 이것은 소켓이 작성시에 바인드 되므로, 로컬에 바인드 된 주소를 변경할 수 없기 때문입니다. 소켓의 디폴트의 로컬 주소는 INADDR_ANY 입니다. 이것은 multi-homed의 호스트상에 있는 임의의 로컬 주소를 의미합니다. 이 옵션을 사용해, multi-homed의 호스트는 복수의 주소 가운데 1 개만으로 접속을 받아들이도록 할 수 있습니다 (ServerSocket 또는 DatagramSocket 의 경우). 혹은 호스트의 리턴 주소를 지정할 수도 있습니다 (Socket 또는 DatagramSocket 가 대상). 이 옵션의 파라미터는 InetAddress (인터넷 주소)입니다.

이 옵션은 constructor 중(안)에서지정되지 않으면 안됩니다.

유효: SocketImpl, DatagramSocketImpl

관련 항목:

Socket.getLocalAddress() , DatagramSocket.getLocalAddress() , 정수 필드치

SO_REUSEADDR

public static final int SO_REUSEADDR

소켓의 SO_REUSEADDR 를 설정합니다. 이것은 java 의 MulticastSockets 에만 사용되어서 , MulticastSockets 에는 디폴트로 설정되어 있습니다.

유효: DatagramSocketImpl

관련 항목:

정수 필드치

SO_BROADCAST

public static final int SO_BROADCAST

소켓의 SO_BROADCAST 를 설정합니다. 이 옵션은 브로드캐스트 메세지를 송신하는 기능을 유효 또는 무효로 합니다. 이것은 데이터 그램 소켓용으로, 브로드캐스트 메세지의 개념을 서포트하는 네트워크 (예를 들어, Ethernet 나 토큰링 등) 상에서만 서포트되어 디폴트에서는 DatagramSockets 용으로 설정되어 있습니다.

도입된 버젼:

1.4

관련 항목:

정수 필드치

IP_MULTICAST_IF

public static final int IP_MULTICAST_IF

멀티 캐스트 패킷을 송신하는 송출 인터페이스를 어느 것으로 하는지 설정합니다. 복수의 네트워크 인터페이스를 가지는 호스트로, 어플리케이션이 시스템의 디폴트 이외의 인터페이스를 사용하지 않으면 안 되는 경우에 편리합니다. InetAddress 를 취득하거나 돌려주거나 합니다.

멀티 캐스트에 유효: DatagramSocketImpl

관련 항목:

MulticastSocket.setInterface(java.net.InetAddress) , MulitcastSocket#getInterface, 정수 필드치

IP_MULTICAST_IF2

public static final int IP_MULTICAST_IF2

상기와 같습니다. 이 옵션은 IP_MULTICAST_IF 를 사용한 동작을 이전과 같게 보관 유지하기 위해서 도입되었습니다. 또, 이 새로운 옵션은 IPv4 또는 IPv6 주소를 사용한 송출 인터페이스의 설정을 서포트할 수 있습니다. 주: 이것과 모순되지 않게 해 주세요.

도입된 버젼:

1.4

관련 항목:

MulticastSocket.setNetworkInterface(java.net.NetworkInterface) , MulticastSocket.getNetworkInterface() , 정수 필드치

IP_MULTICAST_LOOP

public static final int IP_MULTICAST_LOOP

이 옵션은 멀티 캐스트 데이터 그램의 로컬 루프백을 유효 또는 무효로 합니다. 디폴트에서는 이 옵션은 멀티 캐스트 소켓용으로 유효하게 되어 있습니다.

도입된 버젼:

1.4

관련 항목:

정수 필드치

IP_TOS

public static final int IP_TOS

이 옵션은 TCP 또는 UDP 소켓의 IP 헤더의 서비스 타입 또는 트래픽 클래스 필드를 설정합니다.

도입된 버젼:

1.4

관련 항목:

정수 필드치

SO_LINGER

public static final int SO_LINGER

linger-on-close 타임 아웃을 지정합니다. 이 옵션은 TCP 소켓의 close() 를 즉석에서 돌려주는 처리를 유효 또는 무효로 합니다. 이 옵션에 제로가 아닌 정수의 타임 아웃을 지정해 유효하게 하면(자),close() 는 블록 되어, 피어에 기입해지는 전데이터의 전송, 및 승인을 연기시켜, 그 시점에서 소켓을 닫습니다. 지연 타임 아웃에 도달한 시점에서, 소켓은 TCP RST 로 강제적으로 닫혀집니다. 타임 아웃 제로로 이 옵션을 유효하게 하면(자), 즉석에서 강제적으로 (소켓을) 닫습니다. 지정된 타임 아웃이 65,535 를 넘고 있는 경우는 65,535 로 설정됩니다.

TCP 에만 유효: SocketImpl

관련 항목:

Socket.setSoLinger(boolean, int) , Socket.getSoLinger() , 정수 필드치

SO_TIMEOUT

public static final int SO_TIMEOUT

소켓 조작의 블록에 타임 아웃을 설정합니다.

ServerSocket.accept();
SocketInputStream.read();
DatagramSocket.receive();

옵션의 설정은 블록 조작이 유효하게 되기 전에 실시하지 않으면 안됩니다. 타임 아웃이 지나도 조작의 블록이 계속되고 있는 경우는 java.io.InterruptedIOException 가 슬로우 됩니다. 이 경우, 소켓은 닫혀지지 않습니다.

모든 소켓으로 유효: SocketImpl, DatagramSocketImpl

관련 항목:

Socket.setSoTimeout(int) , ServerSocket.setSoTimeout(int) , DatagramSocket.setSoTimeout(int) , 정수 필드치

SO_SNDBUF

public static final int SO_SNDBUF

송신 네트워크 입출력용으로서 플랫폼에서 사용되는 버퍼의 사이즈의 힌트를 설정합니다. 설정으로 사용되는 경우는 소켓으로 송신하는 데이터에 사용되는 버퍼의 사이즈에 대해서는 어플리케이션으로부터 커넬에의 추천치가 됩니다. 취득으로 사용되는 경우는 이 소켓으로 데이터를 송신할 경우에 플랫폼이 실제로 사용하는 버퍼의 사이즈가 돌려주어집니다. 모든 소켓 (SocketImpl, DatagramSocketImp)으로 유효합니다.

관련 항목:

Socket.setSendBufferSize(int) , Socket.getSendBufferSize() , DatagramSocket.setSendBufferSize(int) , DatagramSocket.getSendBufferSize() , 정수 필드치

SO_RCVBUF

public static final int SO_RCVBUF

수신 네트워크 입출력용으로서 플랫폼에서 사용되는 버퍼의 사이즈의 힌트를 설정합니다. 설정으로 사용되는 경우는 소켓으로 수신하는 데이터에 사용되는 버퍼의 사이즈에 대해서는 어플리케이션으로부터 커넬에의 추천치가 됩니다. 취득으로 사용되는 경우는 이 소켓으로 데이터를 수신할 경우에 플랫폼이 실제로 사용하는 버퍼의 사이즈가 돌려주어집니다. 모든 소켓 (SocketImpl, DatagramSocketImp)으로 유효합니다.

관련 항목:

Socket.setReceiveBufferSize(int) , Socket.getReceiveBufferSize() , DatagramSocket.setReceiveBufferSize(int) , DatagramSocket.getReceiveBufferSize() , 정수 필드치

SO_KEEPALIVE

public static final int SO_KEEPALIVE

TCP 소켓에 KeepAlive 옵션이 설정되어 있어, 소켓을 개입시켜 어느 방향에도 데이터가 2 시간 (주: 실제의 값은 구현에 의한다)의 사이 교환되어 있지 않은 경우, TCP 는 자동적으로 KeepAlive 프로브를 피어에 송신합니다. 이 프로브는 피어가 응답할 필요가 있는 TCP 세그먼트(segment)입니다. 다음의 3 개중 어느인가가 생각됩니다. 1. 피어는 예상되는 ACK 로 응답한다. 만사 지장 없기 때문에, 어플리케이션에는 통지하지 않는다. TCP 는 게다가 2 시간 데이터 교환을 하지 않으면 프로브를 송신한다. 2. 피어는 피어 호스트가 크래쉬 해 재기동한 로컬 TCP 를 나타내는 RST 로 응답한다. 소켓은 닫혀진다. 3. 피어로부터의 응답이 없다. 소켓은 닫혀진다. 이 옵션의 목적은 피어 호스트가 크래쉬 했을 경우에 검출하는 것입니다. TCP 소켓 (SocketImp)에만 유효합니다.

관련 항목:

Socket.setKeepAlive(boolean) , Socket.getKeepAlive() , 정수 필드치

SO_OOBINLINE

public static final int SO_OOBINLINE

OOBINLINE 옵션이 설정되어 있으면(자), 소켓으로 수신되는 TCP 긴급 데이터는 모두 소켓 입력 스트림을 경유해 수신됩니다. 이 옵션이 무효가 되어 있는 경우 (디폴트), 긴급 데이터는 그대로 파기됩니다.

관련 항목:

Socket.setOOBInline(boolean) , Socket.getOOBInline() , 정수 필드치

메소드의 상세

setOption

public void setOption(int optID,
                      Object  value)
               throws SocketException 

optID 로 지정된 옵션을 유효 또는 무효로 합니다. 유효하게 하는 옵션이 그 옵션 특유의 「값」을 받는 경우는 value 로서 건네받습니다. 값의 실제의 형태는 옵션에 따라서 다릅니다. 옵션으로 상정되고 있는 형태와는 다른 형태의 값을 건네주었을 경우는 에러가 됩니다.

SocketImpl s;
 ...
s.setOption(SO_LINGER, new Integer(10));
// OK - set SO_LINGER w/ timeout of 10 sec.
s.setOption(SO_LINGER, new Double(10));
// ERROR - expects java.lang.Integer

요구되는 옵션이 바이너리치의 경우는 java.lang.Boolean 에 의한 다음의 메소드를 사용해 설정할 수 있습니다.

s.setOption(TCP_NODELAY, new Boolean(true));
// OK - enables TCP_NODELAY, a binary option

Boolean(false)와 함께 이 메소드를 사용하면(자), 임의의 옵션을 무효로 할 수 있습니다.

s.setOption(TCP_NODELAY, new Boolean(false));
// OK - disables TCP_NODELAY
s.setOption(SO_LINGER, new Boolean(false));
// OK - disables SO_LINGER

온 오프의 통지가 있어, boolean 형이 아닌 파라미터가 필요한 옵션에 대해서는 이 값을 Boolean(false) 이외에 설정하면, 옵션이 암묵중에 유효하게 됩니다.
옵션이 인식되지 않는 경우, 소켓이 닫혀지고 있는 경우, 혹은 하등의 저레벨의 에러가 발생했을 경우에는 SocketException 가 슬로우 됩니다.

파라미터:

optID - 옵션의 ID (식별자)

value - 소켓의 옵션의 파라미터

예외:

SocketException - 옵션이 인식되지 않는 경우, 소켓이 닫혀지고 있는 경우, 혹은 하등의 저레벨 에러가 발생했을 경우

관련 항목:

getOption(int)

getOption

public Object  getOption(int optID)
                 throws SocketException 

옵션의 값을 취득합니다. 바이너리치의 옵션은 유효하면 java.lang.Boolean(true)를 돌려주어, 무효이면 java.lang.Boolean(false)를 돌려줍니다. 다음에 예를 나타냅니다.

SocketImpl s;
 ...
Boolean noDelay = (Boolean)(s.getOption(TCP_NODELAY));
if (noDelay.booleanValue()) {
// true if TCP_NODELAY is enabled...
 ...
 }

특정의 형태를 파라미터로서 취하는 옵션에 대해서는 getOption(int)는 파라미터의 값을 돌려줍니다. 그렇지 않은 경우는 java.lang.Boolean(false)가 돌려주어집니다.

Object o = s.getOption(SO_LINGER);
if (o instanceof Integer) {
System.out.print("Linger time is " + ((Integer) o). intValue());
} else {
// the true type of o is java.lang.Boolean(false);
 }

파라미터:

optID - 취득하는 옵션을 지정한 int 치

반환값:

옵션의 값

예외:

SocketException - 소켓이 닫혀지고 있는 경우

SocketException - optID 가, 프로토콜 스택 (SocketImpl 를 포함한다)으로 미지인 경우

관련 항목:

setOption(int, java.lang.Object)