io.micronaut.http.server.netty

Interface NettyEmbeddedServices

All Known Implementing Classes:

DefaultNettyEmbeddedServerFactory

@Internal
public interface NettyEmbeddedServices

Internal interface with services required by the NettyHttpServer. e

Since:

3.1.0

Author:

graemerocher

Method Summary

Modifier and Type	Method and Description
io.netty.channel.EventLoopGroup	createEventLoopGroup(EventLoopGroupConfiguration config) Creates the event loop group configuration.
io.netty.channel.EventLoopGroup	createEventLoopGroup(int numThreads, ExecutorService executorService, Integer ioRatio) Creates the event loop group configuration.
ApplicationContext	getApplicationContext()
ChannelOptionFactory	getChannelOptionFactory()
default io.netty.channel.ServerChannel	getDomainServerChannelInstance(EventLoopGroupConfiguration workerConfig) Gets the domain server socket channel instance.
EventLoopGroupRegistry	getEventLoopGroupRegistry()
<E> ApplicationEventPublisher<E>	getEventPublisher(Class<E> eventClass) Get an event publisher for the server for the given type.
default ExecutorSelector	getExecutorSelector()
HttpCompressionStrategy	getHttpCompressionStrategy()
MediaTypeCodecRegistry	getMediaTypeCodecRegistry()
List<io.netty.channel.ChannelOutboundHandler>	getOutboundHandlers()
default RequestArgumentSatisfier	getRequestArgumentSatisfier()
RouteExecutor	getRouteExecutor()
default Router	getRouter()
io.netty.channel.socket.ServerSocketChannel	getServerSocketChannelInstance(EventLoopGroupConfiguration workerConfig) Gets the server socket channel instance.
ServerSslBuilder	getServerSslBuilder()
StaticResourceResolver	getStaticResourceResolver()
WebSocketBeanRegistry	getWebSocketBeanRegistry()

Method Detail

getOutboundHandlers

@NonNull
List<io.netty.channel.ChannelOutboundHandler> getOutboundHandlers()

Returns:

The channel outbound handlers

getApplicationContext

@NonNull
ApplicationContext getApplicationContext()

Returns:

The application context

getRequestArgumentSatisfier

@NonNull
default RequestArgumentSatisfier getRequestArgumentSatisfier()

Returns:

The request argument satisfier

See Also:

RequestArgumentSatisfier

getRouteExecutor

@NonNull
RouteExecutor getRouteExecutor()

Returns:

The route executor

See Also:

RouteExecutor

getMediaTypeCodecRegistry

@NonNull
MediaTypeCodecRegistry getMediaTypeCodecRegistry()

Returns:

The media type code registry

See Also:

MediaTypeCodecRegistry

getStaticResourceResolver

@NonNull
StaticResourceResolver getStaticResourceResolver()

Returns:

The static resource resolver

See Also:

StaticResourceResolver

getExecutorSelector

@NonNull
default ExecutorSelector getExecutorSelector()

Returns:

The executor resolver

getServerSslBuilder

@Nullable
ServerSslBuilder getServerSslBuilder()

Returns:

The server SSL builder or null if none is configured

See Also:

CertificateProvidedSslBuilder

getChannelOptionFactory

@NonNull
ChannelOptionFactory getChannelOptionFactory()

Returns:

The channel option factory

getHttpCompressionStrategy

@NonNull
HttpCompressionStrategy getHttpCompressionStrategy()

Returns:

The http compression strategy

getWebSocketBeanRegistry

@NonNull
WebSocketBeanRegistry getWebSocketBeanRegistry()

Returns:

The websocket bean registry

getEventLoopGroupRegistry

@NonNull
EventLoopGroupRegistry getEventLoopGroupRegistry()

Returns:

The event loop group registry.

getRouter

@NonNull
default Router getRouter()

Returns:

Obtains the router

createEventLoopGroup

@NonNull
io.netty.channel.EventLoopGroup createEventLoopGroup(@NonNull
                                                              EventLoopGroupConfiguration config)

Creates the event loop group configuration.

Parameters:

config - The config

Returns:

The event loop group config

createEventLoopGroup

@NonNull
io.netty.channel.EventLoopGroup createEventLoopGroup(int numThreads,
                                                              @NonNull
                                                              ExecutorService executorService,
                                                              @Nullable
                                                              Integer ioRatio)

Creates the event loop group configuration.

Parameters:

numThreads - The number of threads

executorService - The executor service

ioRatio - The I/O ratio

Returns:

The event loop group

getServerSocketChannelInstance

@NonNull
io.netty.channel.socket.ServerSocketChannel getServerSocketChannelInstance(@NonNull
                                                                                    EventLoopGroupConfiguration workerConfig)

Gets the server socket channel instance.

Parameters:

workerConfig - The worker config

Returns:

The ServerSocketChannel

getDomainServerChannelInstance

@NonNull
default io.netty.channel.ServerChannel getDomainServerChannelInstance(@NonNull
                                                                               EventLoopGroupConfiguration workerConfig)

Gets the domain server socket channel instance.

Parameters:

workerConfig - The worker config

Returns:

The DomainSocketChannel

Throws:

UnsupportedOperationException - if domain sockets are not supported.

getEventPublisher

@NonNull
<E> ApplicationEventPublisher<E> getEventPublisher(@NonNull
                                                            Class<E> eventClass)

Get an event publisher for the server for the given type.

Type Parameters:

E - The event generic type

Parameters:

eventClass - The event publisher

Returns:

The event publisher