io.micronaut.http.netty.channel

Interface EventLoopGroupFactory

All Known Implementing Classes:

DefaultEventLoopGroupFactory, EpollEventLoopGroupFactory, KQueueEventLoopGroupFactory, NioEventLoopGroupFactory

public interface EventLoopGroupFactory

Factory for EventLoopGroup.

Since:

1.2.0

Author:

croudet, graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static String	NATIVE Qualifier used to resolve the native factory.

Method Summary

Modifier and Type	Method and Description
Class<? extends io.netty.channel.socket.SocketChannel>	clientSocketChannelClass(EventLoopGroupConfiguration configuration) Returns the client channel class.
default io.netty.channel.socket.SocketChannel	clientSocketChannelInstance(EventLoopGroupConfiguration configuration) Returns the client channel class instance.
default io.netty.channel.EventLoopGroup	createEventLoopGroup(EventLoopGroupConfiguration configuration, ThreadFactory threadFactory) Create an event loop group for the given configuration and thread factory.
io.netty.channel.EventLoopGroup	createEventLoopGroup(int threads, Executor executor, Integer ioRatio) Creates an EventLoopGroup.
default io.netty.channel.EventLoopGroup	createEventLoopGroup(int threads, Integer ioRatio) Creates an EventLoopGroup.
io.netty.channel.EventLoopGroup	createEventLoopGroup(int threads, ThreadFactory threadFactory, Integer ioRatio) Creates an EventLoopGroup.
default Class<? extends io.netty.channel.unix.ServerDomainSocketChannel>	domainServerSocketChannelClass() Returns the domain socket server channel class.
default Class<? extends io.netty.channel.unix.ServerDomainSocketChannel>	domainServerSocketChannelClass(EventLoopGroupConfiguration configuration) Returns the domain socket server channel class.
default io.netty.channel.ServerChannel	domainServerSocketChannelInstance(EventLoopGroupConfiguration configuration) Returns the domain socket server channel class.
default boolean	isNative()
Class<? extends io.netty.channel.socket.ServerSocketChannel>	serverSocketChannelClass() Returns the server channel class.
default Class<? extends io.netty.channel.socket.ServerSocketChannel>	serverSocketChannelClass(EventLoopGroupConfiguration configuration) Returns the server channel class.
default io.netty.channel.socket.ServerSocketChannel	serverSocketChannelInstance(EventLoopGroupConfiguration configuration) Returns the server channel class instance.

Field Detail

NATIVE

static final String NATIVE

Qualifier used to resolve the native factory.

See Also:

Constant Field Values

Method Detail

isNative

default boolean isNative()

Returns:

Is this a native factory.

createEventLoopGroup

io.netty.channel.EventLoopGroup createEventLoopGroup(int threads,
                                                     Executor executor,
                                                     @Nullable
                                                     Integer ioRatio)

Creates an EventLoopGroup.

Parameters:

threads - The number of threads to use.

executor - An Executor.

ioRatio - The io ratio.

Returns:

An EventLoopGroup.

createEventLoopGroup

default io.netty.channel.EventLoopGroup createEventLoopGroup(EventLoopGroupConfiguration configuration,
                                                             ThreadFactory threadFactory)

Create an event loop group for the given configuration and thread factory.

Parameters:

configuration - The configuration

threadFactory - The thread factory

Returns:

The event loop group

createEventLoopGroup

io.netty.channel.EventLoopGroup createEventLoopGroup(int threads,
                                                     @Nullable
                                                     ThreadFactory threadFactory,
                                                     @Nullable
                                                     Integer ioRatio)

Creates an EventLoopGroup.

Parameters:

threads - The number of threads to use.

threadFactory - The thread factory.

ioRatio - The io ratio.

Returns:

An EventLoopGroup.

createEventLoopGroup

default io.netty.channel.EventLoopGroup createEventLoopGroup(int threads,
                                                             @Nullable
                                                             Integer ioRatio)

Creates an EventLoopGroup.

Parameters:

threads - The number of threads to use.

ioRatio - The io ratio.

Returns:

An EventLoopGroup.

serverSocketChannelClass

@NonNull
Class<? extends io.netty.channel.socket.ServerSocketChannel> serverSocketChannelClass()

Returns the server channel class.

Returns:

A ServerChannelClass.

domainServerSocketChannelClass

@NonNull
default Class<? extends io.netty.channel.unix.ServerDomainSocketChannel> domainServerSocketChannelClass()
                                                                                                          throws UnsupportedOperationException

Returns the domain socket server channel class.

Returns:

A ServerDomainSocketChannel class.

Throws:

UnsupportedOperationException - if domain sockets are not supported.

serverSocketChannelClass

@NonNull
default Class<? extends io.netty.channel.socket.ServerSocketChannel> serverSocketChannelClass(@Nullable
                                                                                                       EventLoopGroupConfiguration configuration)

Returns the server channel class.

Parameters:

configuration - The configuration

Returns:

A ServerSocketChannel class.

domainServerSocketChannelClass

@NonNull
default Class<? extends io.netty.channel.unix.ServerDomainSocketChannel> domainServerSocketChannelClass(@Nullable
                                                                                                                 EventLoopGroupConfiguration configuration)

Returns the domain socket server channel class.

Parameters:

configuration - The configuration

Returns:

A ServerDomainSocketChannel implementation.

Throws:

UnsupportedOperationException - if domain sockets are not supported.

serverSocketChannelInstance

@NonNull
default io.netty.channel.socket.ServerSocketChannel serverSocketChannelInstance(@Nullable
                                                                                         EventLoopGroupConfiguration configuration)

Returns the server channel class instance.

Parameters:

configuration - The configuration

Returns:

A ServerSocketChannel instance.

domainServerSocketChannelInstance

@NonNull
default io.netty.channel.ServerChannel domainServerSocketChannelInstance(@Nullable
                                                                                  EventLoopGroupConfiguration configuration)

Returns the domain socket server channel class.

Parameters:

configuration - The configuration

Returns:

A ServerDomainSocketChannel implementation.

Throws:

UnsupportedOperationException - if domain sockets are not supported.

clientSocketChannelClass

@NonNull
Class<? extends io.netty.channel.socket.SocketChannel> clientSocketChannelClass(@Nullable
                                                                                         EventLoopGroupConfiguration configuration)

Returns the client channel class.

Parameters:

configuration - The configuration

Returns:

A SocketChannel class.

clientSocketChannelInstance

@NonNull
default io.netty.channel.socket.SocketChannel clientSocketChannelInstance(@Nullable
                                                                                   EventLoopGroupConfiguration configuration)

Returns the client channel class instance.

Parameters:

configuration - The configuration

Returns:

A SocketChannel instance.