Package software.amazon.awssdk.http.nio.netty

Class SdkEventLoopGroup

java.lang.Object

software.amazon.awssdk.http.nio.netty.SdkEventLoopGroup

public final class SdkEventLoopGroup
extends Object

Provides EventLoopGroup and ChannelFactory for NettyNioAsyncHttpClient.

There are three ways to create a new instance.

• using builder() to provide custom configuration of EventLoopGroup. This is the preferred configuration method when you just want to customize the EventLoopGroup
• Using create(EventLoopGroup) to provide a custom EventLoopGroup. ChannelFactory will be resolved based on the type of EventLoopGroup provided via ChannelResolver.resolveSocketChannelFactory(EventLoopGroup) and ChannelResolver.resolveDatagramChannelFactory(EventLoopGroup)
• Using create(EventLoopGroup, ChannelFactory) to provide a custom EventLoopGroup and ChannelFactory

When configuring the EventLoopGroup of NettyNioAsyncHttpClient, if SdkEventLoopGroup.Builder is passed to NettyNioAsyncHttpClient.Builder.eventLoopGroupBuilder(software.amazon.awssdk.http.nio.netty.SdkEventLoopGroup.Builder), the EventLoopGroup is managed by the SDK and will be shutdown when the HTTP client is closed. Otherwise, if an instance of SdkEventLoopGroup is passed to NettyNioAsyncHttpClient.Builder.eventLoopGroup(software.amazon.awssdk.http.nio.netty.SdkEventLoopGroup), the EventLoopGroup MUST be closed by the caller when it is ready to be disposed. The SDK will not close the EventLoopGroup when the HTTP client is closed. See EventExecutorGroup.shutdownGracefully() to properly close the event loop group.

See Also:

NettyNioAsyncHttpClient.Builder.eventLoopGroupBuilder(Builder), NettyNioAsyncHttpClient.Builder.eventLoopGroup(SdkEventLoopGroup)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SdkEventLoopGroup.Builder	A builder for SdkEventLoopGroup.

Method Summary

Modifier and Type	Method	Description
static SdkEventLoopGroup.Builder	builder()
io.netty.channel.ChannelFactory<? extends io.netty.channel.Channel>	channelFactory()
static SdkEventLoopGroup	create(io.netty.channel.EventLoopGroup eventLoopGroup)	Creates a new instance of SdkEventLoopGroup with EventLoopGroup.
static SdkEventLoopGroup	create(io.netty.channel.EventLoopGroup eventLoopGroup, io.netty.channel.ChannelFactory<? extends io.netty.channel.Channel> channelFactory)	Creates a new instance of SdkEventLoopGroup with EventLoopGroup and ChannelFactory to be used with NettyNioAsyncHttpClient.
io.netty.channel.ChannelFactory<? extends io.netty.channel.socket.DatagramChannel>	datagramChannelFactory()
io.netty.channel.EventLoopGroup	eventLoopGroup()

Methods inherited from class java.lang.Object

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

Method Detail

eventLoopGroup

public io.netty.channel.EventLoopGroup eventLoopGroup()

Returns:

the EventLoopGroup to be used with Netty Http client.

channelFactory

public io.netty.channel.ChannelFactory<? extends io.netty.channel.Channel> channelFactory()

Returns:

the ChannelFactory to be used with Netty Http Client.

datagramChannelFactory

public io.netty.channel.ChannelFactory<? extends io.netty.channel.socket.DatagramChannel> datagramChannelFactory()

Returns:

the ChannelFactory for datagram channels to be used with Netty Http Client.

create

public static SdkEventLoopGroup create(io.netty.channel.EventLoopGroup eventLoopGroup,
                                       io.netty.channel.ChannelFactory<? extends io.netty.channel.Channel> channelFactory)

Creates a new instance of SdkEventLoopGroup with EventLoopGroup and ChannelFactory to be used with NettyNioAsyncHttpClient.

Parameters:

eventLoopGroup - the EventLoopGroup to be used

channelFactory - the channel factor to be used

Returns:

a new instance of SdkEventLoopGroup

create

public static SdkEventLoopGroup create(io.netty.channel.EventLoopGroup eventLoopGroup)

Creates a new instance of SdkEventLoopGroup with EventLoopGroup.

ChannelFactory will be resolved based on the type of EventLoopGroup provided. IllegalArgumentException will be thrown for any unknown EventLoopGroup type.

Parameters:

eventLoopGroup - the EventLoopGroup to be used

Returns:

a new instance of SdkEventLoopGroup

builder

public static SdkEventLoopGroup.Builder builder()