Package io.servicetalk.transport.netty.internal

Class NettyIoExecutors

java.lang.Object

io.servicetalk.transport.netty.internal.NettyIoExecutors

public final class NettyIoExecutors
extends Object

A static factory to create or convert to NettyIoExecutor.

Method Summary

Modifier and Type	Method	Description
static EventLoopAwareNettyIoExecutor	createIoExecutor()	Create a new NettyIoExecutor with the default number of ioThreads.
static EventLoopAwareNettyIoExecutor	createIoExecutor(int ioThreads)	Create a new NettyIoExecutor.
static <T extends Thread & IoThreadFactory.IoThread> EventLoopAwareNettyIoExecutor	createIoExecutor(int ioThreads, IoThreadFactory<T> threadFactory)	Create a new NettyIoExecutor.
static EventLoopAwareNettyIoExecutor	createIoExecutor(int ioThreads, String threadNamePrefix)	Create a new NettyIoExecutor.
static <T extends Thread & IoThreadFactory.IoThread> EventLoopAwareNettyIoExecutor	createIoExecutor(IoThreadFactory<T> threadFactory)	Create a new NettyIoExecutor with the default number of ioThreads.
static EventLoopAwareNettyIoExecutor	createIoExecutor(String threadNamePrefix)	Create a new NettyIoExecutor with the default number of ioThreads.
static NettyIoExecutor	fromNettyEventLoop(io.netty.channel.EventLoop eventLoop)	Deprecated. Use fromNettyEventLoop(EventLoop, boolean).
static NettyIoExecutor	fromNettyEventLoop(io.netty.channel.EventLoop eventLoop, boolean isIoThreadSupported)	Creates a new instance of NettyIoExecutor using the passed EventLoop.
static NettyIoExecutor	fromNettyEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)	Deprecated. Use fromNettyEventLoopGroup(EventLoopGroup, boolean).
static NettyIoExecutor	fromNettyEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup, boolean isIoThreadSupported)	Creates a new instance of NettyIoExecutor using the passed EventLoopGroup.
static NettyIoExecutor	toNettyIoExecutor(IoExecutor ioExecutor)	Deprecated. Use EventLoopAwareNettyIoExecutors.toEventLoopAwareNettyIoExecutor(IoExecutor).

Methods inherited from class java.lang.Object

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

Method Details

createIoExecutor

public static EventLoopAwareNettyIoExecutor createIoExecutor()

Create a new NettyIoExecutor with the default number of ioThreads.

Returns:

The created IoExecutor

createIoExecutor

public static EventLoopAwareNettyIoExecutor createIoExecutor(String threadNamePrefix)

Create a new NettyIoExecutor with the default number of ioThreads.

Parameters:

threadNamePrefix - the name prefix used for the created Threads.

Returns:

The created IoExecutor

createIoExecutor

public static EventLoopAwareNettyIoExecutor createIoExecutor(int ioThreads)

Create a new NettyIoExecutor.

Parameters:

ioThreads - number of threads or 0 (zero) to use the default value.

Returns:

The created IoExecutor

createIoExecutor

public static EventLoopAwareNettyIoExecutor createIoExecutor(int ioThreads,
 String threadNamePrefix)

Create a new NettyIoExecutor.

Parameters:

ioThreads - number of threads or 0 (zero) to use the default value.

threadNamePrefix - the name prefix used for the created Threads.

Returns:

The created IoExecutor

createIoExecutor

public static <T extends Thread & IoThreadFactory.IoThread>
EventLoopAwareNettyIoExecutor createIoExecutor(IoThreadFactory<T> threadFactory)

Create a new NettyIoExecutor with the default number of ioThreads.

Type Parameters:

T - Type of the IO thread instances created by factory.

Parameters:

threadFactory - the IoThreadFactory to use. If possible you should use an instance of NettyIoThreadFactory as it allows internal optimizations.

Returns:

The created IoExecutor

createIoExecutor

public static <T extends Thread & IoThreadFactory.IoThread>
EventLoopAwareNettyIoExecutor createIoExecutor(int ioThreads,
 IoThreadFactory<T> threadFactory)

Create a new NettyIoExecutor.

Type Parameters:

T - Type of the IO thread instances created by factory.

Parameters:

ioThreads - number of threads or 0 (zero) to use the default value.

threadFactory - the IoThreadFactory to use. If possible you should use an instance of NettyIoThreadFactory as it allows internal optimizations.

Returns:

The created IoExecutor

toNettyIoExecutor

@Deprecated
public static NettyIoExecutor toNettyIoExecutor(IoExecutor ioExecutor)

Deprecated.

Use EventLoopAwareNettyIoExecutors.toEventLoopAwareNettyIoExecutor(IoExecutor).

Attempts to convert the passed IoExecutor to a NettyIoExecutor.

Parameters:

ioExecutor - IoExecutor to convert.

Returns:

NettyIoExecutor corresponding to the passed IoExecutor.

Throws:

IllegalArgumentException - If IoExecutor is not of type NettyIoExecutor.

fromNettyEventLoop

@Deprecated
public static NettyIoExecutor fromNettyEventLoop(io.netty.channel.EventLoop eventLoop)

Deprecated.

Use fromNettyEventLoop(EventLoop, boolean).

Creates a new instance of NettyIoExecutor using the passed EventLoop.

Parameters:

eventLoop - EventLoop to use to create a new NettyIoExecutor.

Returns:

New NettyIoExecutor using the passed EventLoop.

fromNettyEventLoop

public static NettyIoExecutor fromNettyEventLoop(io.netty.channel.EventLoop eventLoop,
 boolean isIoThreadSupported)

Creates a new instance of NettyIoExecutor using the passed EventLoop.

Parameters:

eventLoop - EventLoop to use to create a new NettyIoExecutor.

isIoThreadSupported - if true then event loop threads are guaranteed to implement IoThreadFactory.IoThread contract. Note: passing an incorrect value here may result in unexpected behavior and incorrect offloading.

Returns:

New NettyIoExecutor using the passed EventLoop.

fromNettyEventLoopGroup

@Deprecated
public static NettyIoExecutor fromNettyEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)

Deprecated.

Use fromNettyEventLoopGroup(EventLoopGroup, boolean).

Creates a new instance of NettyIoExecutor using the passed EventLoopGroup.

Parameters:

eventLoopGroup - EventLoopGroup to use to create a new NettyIoExecutor.

Returns:

New NettyIoExecutor using the passed EventLoopGroup.

fromNettyEventLoopGroup

public static NettyIoExecutor fromNettyEventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup,
 boolean isIoThreadSupported)

Creates a new instance of NettyIoExecutor using the passed EventLoopGroup.

Parameters:

eventLoopGroup - EventLoopGroup to use to create a new NettyIoExecutor.

isIoThreadSupported - if true then event loop threads are guaranteed to implement IoThreadFactory.IoThread contract. Note: passing an incorrect value here may result in unexpected behavior and incorrect offloading.

Returns:

New NettyIoExecutor using the passed EventLoopGroup.