Package io.micronaut.http.netty.channel

Class IoUringEventLoopGroupFactory

java.lang.Object

io.micronaut.http.netty.channel.IoUringEventLoopGroupFactory

All Implemented Interfaces:

EventLoopGroupFactory

@Singleton
@Requires(classes=io.netty.incubator.channel.uring.IOUring.class,
          condition=IoUringAvailabilityCondition.class)
@Internal
@Named("native")
@Order(200)
public class IoUringEventLoopGroupFactory
extends Object
implements EventLoopGroupFactory

Factory for IOUringEventLoopGroup.

Since:

4.0.0

Author:

Jonas Konrad

Field Summary

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

NATIVE

Constructor Summary

Constructors

Constructor	Description
IoUringEventLoopGroupFactory()

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.
@NonNull Class<? extends io.netty.channel.socket.SocketChannel>	clientSocketChannelClass(@Nullable EventLoopGroupConfiguration configuration)	Returns the client channel class.
io.netty.channel.socket.SocketChannel	clientSocketChannelInstance(EventLoopGroupConfiguration configuration)	Returns the client channel class instance.
io.netty.channel.EventLoopGroup	createEventLoopGroup(int threads, Executor executor, @Nullable Integer ioRatio)	Creates an IOUringEventLoopGroup.
io.netty.channel.EventLoopGroup	createEventLoopGroup(int threads, ThreadFactory threadFactory, @Nullable Integer ioRatio)	Creates an IOUringEventLoopGroup.
boolean	isNative()
Class<? extends io.netty.channel.socket.ServerSocketChannel>	serverSocketChannelClass()	Returns the server channel class.
@NonNull io.netty.incubator.channel.uring.IOUringServerSocketChannel	serverSocketChannelInstance(@Nullable EventLoopGroupConfiguration configuration)	Returns the server channel class instance.

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, channelInstance, createEventLoopGroup, createEventLoopGroup, domainServerSocketChannelClass, domainServerSocketChannelClass, domainServerSocketChannelInstance, serverSocketChannelClass

Constructor Details

IoUringEventLoopGroupFactory

public IoUringEventLoopGroupFactory()

Method Details

createEventLoopGroup

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

Creates an IOUringEventLoopGroup.

Specified by:

createEventLoopGroup in interface EventLoopGroupFactory

Parameters:

threads - The number of threads to use.

threadFactory - The thread factory.

ioRatio - The io ratio.

Returns:

An IOUringEventLoopGroup.

createEventLoopGroup

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

Creates an IOUringEventLoopGroup.

Specified by:

createEventLoopGroup in interface EventLoopGroupFactory

Parameters:

threads - The number of threads to use.

executor - An Executor.

ioRatio - The io ratio.

Returns:

An IOUringEventLoopGroup.

serverSocketChannelClass

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

Returns the server channel class.

Specified by:

serverSocketChannelClass in interface EventLoopGroupFactory

Returns:

IOUringServerSocketChannel.

serverSocketChannelInstance

@NonNull
public @NonNull io.netty.incubator.channel.uring.IOUringServerSocketChannel serverSocketChannelInstance(@Nullable
 @Nullable EventLoopGroupConfiguration configuration)

Description copied from interface: EventLoopGroupFactory

Returns the server channel class instance.

Specified by:

serverSocketChannelInstance in interface EventLoopGroupFactory

Parameters:

configuration - The configuration

Returns:

A ServerSocketChannel instance.

clientSocketChannelClass

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

Description copied from interface: EventLoopGroupFactory

Returns the client channel class.

Specified by:

clientSocketChannelClass in interface EventLoopGroupFactory

Parameters:

configuration - The configuration

Returns:

A SocketChannel class.

clientSocketChannelInstance

public io.netty.channel.socket.SocketChannel clientSocketChannelInstance(EventLoopGroupConfiguration configuration)

Description copied from interface: EventLoopGroupFactory

Returns the client channel class instance.

Specified by:

clientSocketChannelInstance in interface EventLoopGroupFactory

Parameters:

configuration - The configuration

Returns:

A SocketChannel instance.

isNative

public boolean isNative()

Specified by:

isNative in interface EventLoopGroupFactory

Returns:

Is this a native factory.

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.