Package io.micronaut.http.netty.channel

Class DefaultEventLoopGroupFactory

java.lang.Object

io.micronaut.http.netty.channel.DefaultEventLoopGroupFactory

All Implemented Interfaces:

EventLoopGroupFactory

@Primary
@Singleton
public class DefaultEventLoopGroupFactory
extends Object
implements EventLoopGroupFactory

The default factory for EventLoopGroup instances.

Since:

1.0

Field Summary

Fields inherited from interface io.micronaut.http.netty.channel.EventLoopGroupFactory

NATIVE

Constructor Summary

Constructors

Constructor	Description
DefaultEventLoopGroupFactory(NioEventLoopGroupFactory nioEventLoopGroupFactory, @Nullable EventLoopGroupFactory nativeFactory)	Default constructor.
DefaultEventLoopGroupFactory(NioEventLoopGroupFactory nioEventLoopGroupFactory, @Nullable EventLoopGroupFactory nativeFactory, @Nullable NettyGlobalConfiguration nettyGlobalConfiguration)	Default constructor.

Method Summary

Modifier and Type	Method	Description
Class<? extends io.netty.channel.Channel>	channelClass(NettyChannelType type)	Returns the domain socket server channel class.
Class<? extends io.netty.channel.Channel>	channelClass(NettyChannelType type, @Nullable EventLoopGroupConfiguration configuration)	Returns the domain socket server channel class.
io.netty.channel.Channel	channelInstance(NettyChannelType type, @Nullable EventLoopGroupConfiguration configuration)	Returns the domain socket server channel class.
io.netty.channel.Channel	channelInstance(NettyChannelType type, EventLoopGroupConfiguration configuration, io.netty.channel.Channel parent, int fd)	Returns the channel instance.
io.netty.channel.EventLoopGroup	createEventLoopGroup(int threads, @Nullable ThreadFactory threadFactory, @Nullable Integer ioRatio)	Creates an EventLoopGroup.
io.netty.channel.EventLoopGroup	createEventLoopGroup(int threads, Executor executor, @Nullable Integer ioRatio)	Creates an EventLoopGroup.
io.netty.channel.EventLoopGroup	createEventLoopGroup(EventLoopGroupConfiguration configuration, ThreadFactory threadFactory)	Create an event loop group for the given configuration and thread factory.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.http.netty.channel.EventLoopGroupFactory

channelInstance, clientSocketChannelClass, clientSocketChannelInstance, createEventLoopGroup, domainServerSocketChannelClass, domainServerSocketChannelClass, domainServerSocketChannelInstance, isNative, serverSocketChannelClass, serverSocketChannelClass, serverSocketChannelInstance

Constructor Details

DefaultEventLoopGroupFactory

public DefaultEventLoopGroupFactory(NioEventLoopGroupFactory nioEventLoopGroupFactory,
 @Nullable @Named("native")
 @Nullable EventLoopGroupFactory nativeFactory)

Default constructor.

Parameters:

nioEventLoopGroupFactory - The NIO factory

nativeFactory - The native factory if available

DefaultEventLoopGroupFactory

@Inject
public DefaultEventLoopGroupFactory(NioEventLoopGroupFactory nioEventLoopGroupFactory,
 @Nullable @Named("native")
 @Nullable EventLoopGroupFactory nativeFactory,
 @Nullable
 @Nullable NettyGlobalConfiguration nettyGlobalConfiguration)

Default constructor.

Parameters:

nioEventLoopGroupFactory - The NIO factory

nativeFactory - The native factory if available

nettyGlobalConfiguration - The netty global configuration

Method Details

createEventLoopGroup

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

Description copied from interface: EventLoopGroupFactory

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

Specified by:

createEventLoopGroup in interface EventLoopGroupFactory

Parameters:

configuration - The configuration

threadFactory - The thread factory

Returns:

The event loop group

createEventLoopGroup

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

Description copied from interface: EventLoopGroupFactory

Creates an EventLoopGroup.

Specified by:

createEventLoopGroup in interface EventLoopGroupFactory

Parameters:

threads - The number of threads to use.

executor - An Executor.

ioRatio - The io ratio.

Returns:

An EventLoopGroup.

createEventLoopGroup

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

Description copied from interface: EventLoopGroupFactory

Creates an EventLoopGroup.

Specified by:

createEventLoopGroup in interface EventLoopGroupFactory

Parameters:

threads - The number of threads to use.

threadFactory - The thread factory.

ioRatio - The io ratio.

Returns:

An EventLoopGroup.

channelClass

public Class<? extends io.netty.channel.Channel> channelClass(NettyChannelType type)
                                                       throws UnsupportedOperationException

Description copied from interface: EventLoopGroupFactory

Returns the domain socket server channel class.

Specified by:

channelClass in interface EventLoopGroupFactory

Parameters:

type - Type of the channel to return

Returns:

A channel class.

Throws:

UnsupportedOperationException - if domain sockets are not supported.

channelClass

public Class<? extends io.netty.channel.Channel> channelClass(NettyChannelType type,
 @Nullable
 @Nullable EventLoopGroupConfiguration configuration)

Description copied from interface: EventLoopGroupFactory

Returns the domain socket server channel class.

Specified by:

channelClass in interface EventLoopGroupFactory

Parameters:

type - Type of the channel to return

configuration - The configuration

Returns:

A channel implementation.

channelInstance

public io.netty.channel.Channel channelInstance(NettyChannelType type,
 @Nullable
 @Nullable EventLoopGroupConfiguration configuration)

Description copied from interface: EventLoopGroupFactory

Returns the domain socket server channel class.

Specified by:

channelInstance in interface EventLoopGroupFactory

Parameters:

type - Type of the channel to return

configuration - The configuration

Returns:

A ServerDomainSocketChannel implementation.

channelInstance

public io.netty.channel.Channel channelInstance(NettyChannelType type,
 EventLoopGroupConfiguration configuration,
 io.netty.channel.Channel parent,
 int fd)

Description copied from interface: EventLoopGroupFactory

Returns the channel instance.

Specified by:

channelInstance in interface EventLoopGroupFactory

Parameters:

type - Type of the channel to return

configuration - The configuration

parent - The parent channel

fd - The pre-defined file descriptor

Returns:

A channel implementation.