org.jruby.ext.socket

Enum SocketType

java.lang.Object

java.lang.Enum<SocketType>

org.jruby.ext.socket.SocketType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SocketType>

public enum SocketType
extends java.lang.Enum<SocketType>

Encapsulates behavior across the primary socket types Socket, ServerSocket, and Datagramsocket.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DATAGRAM
SERVER
SOCKET
UNIX
UNKNOWN

Method Summary

Modifier and Type	Method and Description
static SocketType	forChannel(java.nio.channels.Channel channel)
boolean	getBroadcast(java.nio.channels.Channel channel)
boolean	getKeepAlive(java.nio.channels.Channel channel)
java.net.SocketAddress	getLocalSocketAddress(java.nio.channels.Channel channel)
boolean	getOOBInline(java.nio.channels.Channel channel)
int	getReceiveBufferSize(java.nio.channels.Channel channel)
java.net.SocketAddress	getRemoteSocketAddress(java.nio.channels.Channel channel)
boolean	getReuseAddress(java.nio.channels.Channel channel)
int	getSendBufferSize(java.nio.channels.Channel channel)
int	getSocketOption(java.nio.channels.Channel channel, jnr.constants.platform.SocketOption option)
jnr.constants.platform.Sock	getSocketType()
int	getSoLinger(java.nio.channels.Channel channel)
int	getSoTimeout(java.nio.channels.Channel channel)
boolean	getTcpNoDelay(java.nio.channels.Channel channel)
void	setBroadcast(java.nio.channels.Channel channel, boolean b)
void	setKeepAlive(java.nio.channels.Channel channel, boolean b)
void	setOOBInline(java.nio.channels.Channel channel, boolean b)
void	setReceiveBufferSize(java.nio.channels.Channel channel, int i)
void	setReuseAddress(java.nio.channels.Channel channel, boolean reuse)
void	setSendBufferSize(java.nio.channels.Channel channel, int size)
void	setSocketOption(java.nio.channels.Channel channel, jnr.constants.platform.SocketOption option, int value)
void	setSoLinger(java.nio.channels.Channel channel, boolean b, int i)
void	setSoTimeout(java.nio.channels.Channel channel, int timeout)
void	setTcpNoDelay(java.nio.channels.Channel channel, boolean b)
void	shutdownInput(java.nio.channels.Channel channel)
void	shutdownOutput(java.nio.channels.Channel channel)
static SocketType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SocketType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SOCKET

public static final SocketType SOCKET

SERVER

public static final SocketType SERVER

DATAGRAM

public static final SocketType DATAGRAM

UNIX

public static final SocketType UNIX

UNKNOWN

public static final SocketType UNKNOWN

Method Detail

values

public static SocketType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SocketType c : SocketType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SocketType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

forChannel

public static SocketType forChannel(java.nio.channels.Channel channel)

getSoTimeout

public int getSoTimeout(java.nio.channels.Channel channel)
                 throws java.io.IOException

Throws:

java.io.IOException

setSoTimeout

public void setSoTimeout(java.nio.channels.Channel channel,
                         int timeout)
                  throws java.io.IOException

Throws:

java.io.IOException

getReuseAddress

public boolean getReuseAddress(java.nio.channels.Channel channel)
                        throws java.io.IOException

Throws:

java.io.IOException

setReuseAddress

public void setReuseAddress(java.nio.channels.Channel channel,
                            boolean reuse)
                     throws java.io.IOException

Throws:

java.io.IOException

getSendBufferSize

public int getSendBufferSize(java.nio.channels.Channel channel)
                      throws java.io.IOException

Throws:

java.io.IOException

setSendBufferSize

public void setSendBufferSize(java.nio.channels.Channel channel,
                              int size)
                       throws java.io.IOException

Throws:

java.io.IOException

getReceiveBufferSize

public int getReceiveBufferSize(java.nio.channels.Channel channel)
                         throws java.io.IOException

Throws:

java.io.IOException

setReceiveBufferSize

public void setReceiveBufferSize(java.nio.channels.Channel channel,
                                 int i)
                          throws java.io.IOException

Throws:

java.io.IOException

getOOBInline

public boolean getOOBInline(java.nio.channels.Channel channel)
                     throws java.io.IOException

Throws:

java.io.IOException

setOOBInline

public void setOOBInline(java.nio.channels.Channel channel,
                         boolean b)
                  throws java.io.IOException

Throws:

java.io.IOException

getSoLinger

public int getSoLinger(java.nio.channels.Channel channel)
                throws java.io.IOException

Throws:

java.io.IOException

setSoLinger

public void setSoLinger(java.nio.channels.Channel channel,
                        boolean b,
                        int i)
                 throws java.io.IOException

Throws:

java.io.IOException

getKeepAlive

public boolean getKeepAlive(java.nio.channels.Channel channel)
                     throws java.io.IOException

Throws:

java.io.IOException

setKeepAlive

public void setKeepAlive(java.nio.channels.Channel channel,
                         boolean b)
                  throws java.io.IOException

Throws:

java.io.IOException

getTcpNoDelay

public boolean getTcpNoDelay(java.nio.channels.Channel channel)
                      throws java.io.IOException

Throws:

java.io.IOException

setTcpNoDelay

public void setTcpNoDelay(java.nio.channels.Channel channel,
                          boolean b)
                   throws java.io.IOException

Throws:

java.io.IOException

getBroadcast

public boolean getBroadcast(java.nio.channels.Channel channel)
                     throws java.io.IOException

Throws:

java.io.IOException

setBroadcast

public void setBroadcast(java.nio.channels.Channel channel,
                         boolean b)
                  throws java.io.IOException

Throws:

java.io.IOException

shutdownInput

public void shutdownInput(java.nio.channels.Channel channel)
                   throws java.io.IOException

Throws:

java.io.IOException

shutdownOutput

public void shutdownOutput(java.nio.channels.Channel channel)
                    throws java.io.IOException

Throws:

java.io.IOException

getRemoteSocketAddress

public java.net.SocketAddress getRemoteSocketAddress(java.nio.channels.Channel channel)

getLocalSocketAddress

public java.net.SocketAddress getLocalSocketAddress(java.nio.channels.Channel channel)

getSocketType

public jnr.constants.platform.Sock getSocketType()

getSocketOption

public int getSocketOption(java.nio.channels.Channel channel,
                           jnr.constants.platform.SocketOption option)
                    throws java.io.IOException

Throws:

java.io.IOException

setSocketOption

public void setSocketOption(java.nio.channels.Channel channel,
                            jnr.constants.platform.SocketOption option,
                            int value)
                     throws java.io.IOException

Throws:

java.io.IOException