Top Description Fields Constructors Methods
reactor.netty.http.server

pack-priv final Class HttpServerTcpConfig

extends TcpServer
Class Inheritance
Annotations
@Deprecated
Imports
io.netty.channel.ChannelOption, .EventLoopGroup, io.netty.channel.group.ChannelGroup, io.netty.handler.logging.LogLevel, io.netty.util.AttributeKey, org.reactivestreams.Publisher, reactor.core.publisher.Mono, reactor.netty.ChannelPipelineConfigurer, .Connection, .ConnectionObserver, .DisposableServer, .NettyInbound, .NettyOutbound, reactor.netty.channel.ChannelMetricsRecorder, reactor.netty.resources.LoopResources, reactor.netty.tcp.SslProvider, .TcpServer, .TcpServerConfig, reactor.util.annotation.Nullable, java.net.SocketAddress, java.util.function.BiFunction, .Consumer, .Function, .Supplier

Deprecated

Use HttpServer methods for TCP level configurations. This class will be removed in version 1.1.0.

This class provides a migration for the HttpServer#tcpConfiguration(Function) in 0.9.x.
Author
Violeta Georgieva

Field Summary

Modifier and TypeField and Description
pack-priv HttpServer
httpServer

Constructor Summary

AccessConstructor and Description
pack-priv
HttpServerTcpConfig(HttpServer httpServer)

Method Summary

Modifier and TypeMethod and Description
public <A> TcpServer
attr(AttributeKey<A>
the AttributeKey key
key, A
the AttributeKey value
value)

Overrides reactor.netty.transport.Transport.attr.

Update the given attribute key or remove it if the value is null.
public Mono<? extends DisposableServer>
bind()

Overrides reactor.netty.transport.ServerTransport.bind.

Binds the ServerTransport and returns a Mono of DisposableServer.
public TcpServer
bindAddress(Supplier<? extends SocketAddress>
A supplier of the address to bind to.
bindAddressSupplier)

Overrides reactor.netty.tcp.TcpServer.bindAddress.

Set a new local address to which this transport should bind on subscribe.
public TcpServer
channelGroup(ChannelGroup
a ChannelGroup
channelGroup)

Overrides reactor.netty.tcp.TcpServer.channelGroup.

Provide a ChannelGroup to hold all active connected channels.
public <A> TcpServer
childAttr(AttributeKey<A>
the attribute key
key, A
the attribute value - null to remove a key
value)

Overrides reactor.netty.transport.ServerTransport.childAttr.

Injects default attribute to the future child Channel connections.
public TcpServer
childObserve(ConnectionObserver
the ConnectionObserver addition
observer)

Overrides reactor.netty.transport.ServerTransport.childObserve.

Set or add the given ConnectionObserver for each remote connection.
public <A> TcpServer
childOption(ChannelOption<A>
the option key
key, A
the option value - null to remove a key
value)

Overrides reactor.netty.transport.ServerTransport.childOption.

Injects default options to the future child Channel connections.
public TcpServerConfig
configuration()

Implements abstract reactor.netty.transport.Transport.configuration.

Return a TransportConfig.
public TcpServer
doOnBind(Consumer<? super TcpServerConfig>
a consumer observing connected events
doOnBind)

Overrides reactor.netty.tcp.TcpServer.doOnBind.

Set or add a callback called when ServerTransport is about to start listening for incoming traffic.
public TcpServer
doOnBound(Consumer<? super DisposableServer>
a consumer observing connected events
doOnBound)

Overrides reactor.netty.tcp.TcpServer.doOnBound.

Set or add a callback called after DisposableServer has been started.
public TcpServer
doOnChannelInit(ChannelPipelineConfigurer
configure the channel pipeline while initializing the channel
doOnChannelInit)

Overrides reactor.netty.transport.Transport.doOnChannelInit.

Configure the channel pipeline while initializing the channel.
public TcpServer
doOnConnection(Consumer<? super Connection>
a consumer observing remote connections
doOnConnection)

Overrides reactor.netty.tcp.TcpServer.doOnConnection.

Set or add a callback called on new remote Connection.
public TcpServer
doOnUnbound(Consumer<? super DisposableServer>
a consumer observing unbound events
doOnUnbound)

Overrides reactor.netty.tcp.TcpServer.doOnUnbound.

Set or add a callback called after DisposableServer has been shutdown.
protected TcpServer
duplicate()

Implements abstract reactor.netty.transport.Transport.duplicate.

Return a new Transport inheriting the current configuration.
public TcpServer
handle(BiFunction<? super NettyInbound, ? super NettyOutbound, ? extends Publisher<Void>>
an I/O handler that can dispose underlying connection when Publisher terminates.
handler)

Overrides reactor.netty.tcp.TcpServer.handle.

Attaches an I/O handler to react on a connected client.
public TcpServer
host(String
the host to bind to.
host)

Overrides reactor.netty.tcp.TcpServer.host.

The host to which this server should bind.
public TcpServer
metrics(boolean
true enables metrics collection; false disables it
enable)

Overrides reactor.netty.tcp.TcpServer.metrics.

Whether to enable metrics to be collected and registered in Micrometer's globalRegistry.
public TcpServer
metrics(boolean
if true enables the metrics on the Transport.
enable, Supplier<? extends ChannelMetricsRecorder>
a supplier for the ChannelMetricsRecorder
recorder)

Overrides reactor.netty.tcp.TcpServer.metrics.

Specifies whether the metrics are enabled on the Transport.
public TcpServer
noSSL()

Overrides reactor.netty.tcp.TcpServer.noSSL.

Removes any previously applied SSL configuration customization.
public TcpServer
observe(ConnectionObserver
the ConnectionObserver to be set or add
observer)

Overrides reactor.netty.transport.Transport.observe.

Set or add the given ConnectionObserver to observe the connection state changes.
public <O> TcpServer
option(ChannelOption<O>
the ChannelOption key
key, O
the ChannelOption value or null
value)

Overrides reactor.netty.transport.Transport.option.

Update the given option key or remove it if the value is null.
public TcpServer
port(int
The port to bind to.
port)

Overrides reactor.netty.tcp.TcpServer.port.

The port to which this server should bind.
public TcpServer
runOn(EventLoopGroup
an eventLoopGroup to share
eventLoopGroup)

Overrides reactor.netty.tcp.TcpServer.runOn.

Run IO loops on the given EventLoopGroup.
public TcpServer
runOn(LoopResources
a LoopResources accepting native runtime expectation and returning an eventLoopGroup
channelResources)

Overrides reactor.netty.tcp.TcpServer.runOn.

Run IO loops on a supplied EventLoopGroup from the LoopResources container.
public TcpServer
runOn(LoopResources
a new loop resources
loopResources, boolean
should prefer running on epoll, kqueue or similar instead of java NIO
preferNative)

Overrides reactor.netty.tcp.TcpServer.runOn.

Run IO loops on a supplied EventLoopGroup from the LoopResources container.
public TcpServer
secure(Consumer<? super SslProvider.SslContextSpec>
builder callback for further customization of SslContext.
sslProviderBuilder)

Overrides reactor.netty.tcp.TcpServer.secure.

Apply an SSL configuration customization via the passed builder.
public TcpServer
secure(SslProvider
The provider to set when configuring SSL
sslProvider)

Overrides reactor.netty.tcp.TcpServer.secure.

Applies an SSL configuration via the passed SslProvider.
public TcpServer
wiretap(boolean
specifies whether the wire logger configuration will be added to the pipeline
enable)

Overrides reactor.netty.tcp.TcpServer.wiretap.

Apply or remove a wire logger configuration using Transport category (logger), DEBUG logger level and AdvancedByteBufFormat#HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.
public TcpServer
wiretap(String
the logger category
category)

Overrides reactor.netty.tcp.TcpServer.wiretap.

Apply a wire logger configuration using the specified category (logger), DEBUG logger level and AdvancedByteBufFormat#HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.
public TcpServer
wiretap(String
the logger category
category, LogLevel
the logger level
level)

Overrides reactor.netty.tcp.TcpServer.wiretap.

Apply a wire logger configuration using the specified category (logger), logger level and AdvancedByteBufFormat#HEX_DUMP for ByteBuf format, which means both events and content will be logged and the content will be in hex format.
Inherited from reactor.netty.tcp.TcpServer:
createwarmup