Module io.netty5.transport

Package io.netty5.channel.socket

Enum SocketProtocolFamily

java.lang.Object

java.lang.Enum<SocketProtocolFamily>

io.netty5.channel.socket.SocketProtocolFamily

All Implemented Interfaces:

Serializable, Comparable<SocketProtocolFamily>, ProtocolFamily

public enum SocketProtocolFamily
extends Enum<SocketProtocolFamily>
implements ProtocolFamily

ProtocolFamily implementation that is used by the different transport implementations.

Enum Constant Summary

Enum Constants

Enum Constant	Description
INET	IPv4
INET6	IPv6
UNIX	Unix Domain Socket

Method Summary

Modifier and Type	Method	Description
static SocketProtocolFamily	of(ProtocolFamily family)	Return the SocketProtocolFamily for the given ProtocolFamily if possible.
ProtocolFamily	toJdkFamily()	Return a ProtocolFamily that is "known" by the JDK itself and represent the same as SocketProtocolFamily.
static SocketProtocolFamily	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SocketProtocolFamily[]	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

Methods inherited from interface java.net.ProtocolFamily

name

Enum Constant Detail

INET

public static final SocketProtocolFamily INET

IPv4

INET6

public static final SocketProtocolFamily INET6

IPv6

UNIX

public static final SocketProtocolFamily UNIX

Unix Domain Socket

Method Detail

values

public static SocketProtocolFamily[] 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 (SocketProtocolFamily c : SocketProtocolFamily.values())
    System.out.println(c);

Returns:

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

valueOf

public static SocketProtocolFamily valueOf(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:

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

NullPointerException - if the argument is null

toJdkFamily

public ProtocolFamily toJdkFamily()

Return a ProtocolFamily that is "known" by the JDK itself and represent the same as SocketProtocolFamily.

Returns:

the JDK ProtocolFamily.

Throws:

UnsupportedOperationException - if it can't be converted.

of

public static SocketProtocolFamily of(ProtocolFamily family)

Return the SocketProtocolFamily for the given ProtocolFamily if possible.

Parameters:

family - the JDK ProtocolFamily to convert.

Returns:

the SocketProtocolFamily.

Throws:

UnsupportedOperationException - if it can't be converted.