alluxio.util.network

Class NettyUtils

java.lang.Object

alluxio.util.network.NettyUtils

@ThreadSafe
public final class NettyUtils
extends Object

Utility methods for working with Netty.

Field Summary

Fields

Modifier and Type	Field and Description
static ChannelType	CHANNEL_TYPE

Method Summary

Modifier and Type	Method and Description
static io.netty.channel.EventLoopGroup	createEventLoop(ChannelType type, int numThreads, String threadPrefix, boolean isDaemon) Creates a Netty EventLoopGroup based on ChannelType.
static void	disableAutoRead(io.netty.channel.Channel channel) Disables auto read for a netty channel.
static void	enableAutoRead(io.netty.channel.Channel channel) Enables auto read for a netty channel.
static Class<? extends io.netty.channel.Channel>	getChannelClass(boolean isDomainSocket, PropertyKey key, AlluxioConfiguration conf) Get the proper channel class.
static ChannelType	getChannelType(PropertyKey key, AlluxioConfiguration conf) Get the proper channel type.
static Class<? extends io.netty.channel.Channel>	getClientChannelClass(boolean isDomainSocket) Returns the correct SocketChannel class based on ChannelType.
static Class<? extends io.netty.channel.ServerChannel>	getServerChannelClass(boolean isDomainSocket, AlluxioConfiguration conf) Returns the correct ServerSocketChannel class for use by the worker.
static Class<? extends io.netty.channel.ServerChannel>	getServerChannelClass(ChannelType workerChannelType, boolean isDomainSocket) Returns the correct ServerSocketChannel class for use by the worker.
static ChannelType	getUserChannel(AlluxioConfiguration conf) Gets the ChannelType properly from the USER_NETWORK_NETTY_CHANNEL property key.
static ChannelType	getWorkerChannel(AlluxioConfiguration conf) Gets the worker channel properly from the WORKER_NETWORK_NETTY_CHANNEL property key.
static boolean	isDomainSocketAccessible(WorkerNetAddress workerNetAddress, AlluxioConfiguration conf)
static boolean	isDomainSocketSupported(WorkerNetAddress workerNetAddress)
static boolean	isNettyEpollAvailable()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHANNEL_TYPE

public static final ChannelType CHANNEL_TYPE

Method Detail

createEventLoop

public static io.netty.channel.EventLoopGroup createEventLoop(ChannelType type,
                                                              int numThreads,
                                                              String threadPrefix,
                                                              boolean isDaemon)

Creates a Netty EventLoopGroup based on ChannelType.

Parameters:

type - Selector for which form of low-level IO we should use

numThreads - target number of threads

threadPrefix - name pattern for each thread. should contain '%d' to distinguish between threads.

isDaemon - if true, the ThreadFactory will create daemon threads.

Returns:

EventLoopGroup matching the ChannelType

getServerChannelClass

public static Class<? extends io.netty.channel.ServerChannel> getServerChannelClass(ChannelType workerChannelType,
                                                                                    boolean isDomainSocket)

Returns the correct ServerSocketChannel class for use by the worker.

Parameters:

workerChannelType - worker channel type

isDomainSocket - whether this is a domain socket server

Returns:

ServerSocketChannel matching the requirements

getServerChannelClass

public static Class<? extends io.netty.channel.ServerChannel> getServerChannelClass(boolean isDomainSocket,
                                                                                    AlluxioConfiguration conf)

Returns the correct ServerSocketChannel class for use by the worker.

Parameters:

isDomainSocket - whether this is a domain socket server

conf - Alluxio configuration

Returns:

ServerSocketChannel matching the requirements

isDomainSocketAccessible

public static boolean isDomainSocketAccessible(WorkerNetAddress workerNetAddress,
                                               AlluxioConfiguration conf)

Parameters:

workerNetAddress - the worker address

conf - Alluxio configuration

Returns:

true if the domain socket is enabled on this client

enableAutoRead

public static void enableAutoRead(io.netty.channel.Channel channel)

Enables auto read for a netty channel.

Parameters:

channel - the netty channel

disableAutoRead

public static void disableAutoRead(io.netty.channel.Channel channel)

Disables auto read for a netty channel.

Parameters:

channel - the netty channel

isDomainSocketSupported

public static boolean isDomainSocketSupported(WorkerNetAddress workerNetAddress)

Parameters:

workerNetAddress - the worker address

Returns:

true if the domain socket is supported by the worker

isNettyEpollAvailable

public static boolean isNettyEpollAvailable()

Returns:

whether netty epoll is available to the system

getUserChannel

public static ChannelType getUserChannel(AlluxioConfiguration conf)

Gets the ChannelType properly from the USER_NETWORK_NETTY_CHANNEL property key.

Parameters:

conf - Alluxio configuration

Returns:

the proper channel type USER_NETWORK_NETTY_CHANNEL

getWorkerChannel

public static ChannelType getWorkerChannel(AlluxioConfiguration conf)

Gets the worker channel properly from the WORKER_NETWORK_NETTY_CHANNEL property key.

Parameters:

conf - Alluxio configuration

Returns:

the proper channel type for WORKER_NETWORK_NETY_CHANNEL

getClientChannelClass

public static Class<? extends io.netty.channel.Channel> getClientChannelClass(boolean isDomainSocket)

Returns the correct SocketChannel class based on ChannelType.

Parameters:

isDomainSocket - whether this is to connect to a domain socket server

Returns:

Channel matching the requirements

getChannelClass

public static Class<? extends io.netty.channel.Channel> getChannelClass(boolean isDomainSocket,
                                                                        PropertyKey key,
                                                                        AlluxioConfiguration conf)

Get the proper channel class. Always returns NioSocketChannel NIO if EPOLL is not available.

Parameters:

isDomainSocket - whether this is for a domain channel

key - the property key for looking up the configured channel type

conf - the Alluxio configuration

Returns:

the channel type to use

getChannelType

public static ChannelType getChannelType(PropertyKey key,
                                         AlluxioConfiguration conf)

Get the proper channel type. Always returns ChannelType NIO if EPOLL is not available.

Parameters:

key - the property key for looking up the configured channel type

conf - the Alluxio configuration

Returns:

the channel type to use