Core functionality for the Reactor Netty library 2.0.0-M3 · reactor.netty5.transport.Transport

Modifier and Type	Field and Description
pack-priv static final Logger	log

Access	Constructor and Description
public	Transport()

Method Summary

Modifier and Type	Method and Description
public < the attribute type A> T	Returns: a new `Transport` reference attr(AttributeKey<A> the `AttributeKey` key key, A the `AttributeKey` value value) Update the given attribute key or remove it if the value is null.
public T	Returns: a new `Transport` bindAddress(Supplier<? extends SocketAddress> A supplier of the address to bind to. bindAddressSupplier) Set a new local address to which this transport should bind on subscribe.
public T	Returns: a new `Transport` reference channelGroup(ChannelGroup a `ChannelGroup` channelGroup) Provide a `ChannelGroup` to hold all active connected channels.
public abstract C	Returns: a `TransportConfig` configuration() Return a `TransportConfig`.
public T	Returns: a new `Transport` reference doOnChannelInit(ChannelPipelineConfigurer configure the channel pipeline while initializing the channel doOnChannelInit) Configure the channel pipeline while initializing the channel.
protected abstract T	Returns: a new `Transport` inheriting the current configuration duplicate() Return a new `Transport` inheriting the current configuration.
protected T	Returns: a new `Transport` reference metrics(boolean true enables metrics collection; false disables it enable) Whether to enable metrics to be collected and registered in Micrometer's `globalRegistry`.
public T	Returns: a new `Transport` reference metrics(boolean if true enables the metrics on the `Transport`. enable, Supplier<? extends ChannelMetricsRecorder> a supplier for the `ChannelMetricsRecorder` recorder) Specifies whether the metrics are enabled on the `Transport`.
public T	Returns: a new `Transport` reference observe(ConnectionObserver the `ConnectionObserver` to be set or add observer) Set or add the given `ConnectionObserver` to observe the connection state changes.
public < the option type O> T	Returns: a new `Transport` reference option(ChannelOption<O> the `ChannelOption` key key, O the `ChannelOption` value or null value) Update the given option key or remove it if the value is null.
public T	Returns: a new `Transport` reference runOn(EventLoopGroup an eventLoopGroup to share eventLoopGroup) Run IO loops on the given `EventLoopGroup`.
public T	Returns: a new `Transport` reference runOn(LoopResources a `LoopResources` accepting native runtime expectation and returning an eventLoopGroup channelResources) Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container.
public T	Returns: a new `Transport` reference runOn(LoopResources a new loop resources loopResources, boolean should prefer running on epoll, kqueue or similar instead of java NIO preferNative) Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container.
public final T	Returns: a new `Transport` reference runOn(LoopResources a new loop resources loopResources, boolean should prefer running on epoll, kqueue or similar instead of java NIO preferNative, ProtocolFamily a specific `ProtocolFamily` to run with family) Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container.
public T	Returns: a new `Transport` reference wiretap(boolean specifies whether the wire logger configuration will be added to the pipeline enable) Apply or remove a wire logger configuration using `Transport` category (logger), `DEBUG` logger level and `AdvancedBufferFormat#HEX_DUMP` for `Buffer` format, which means both events and content will be logged and the content will be in hex format.
public T	Returns: a new `Transport` reference wiretap(String the logger category category) Apply a wire logger configuration using the specified category (logger), `DEBUG` logger level and `AdvancedBufferFormat#HEX_DUMP` for `Buffer` format, which means both events and content will be logged and the content will be in hex format.
public T	Returns: a new `Transport` reference wiretap(String the logger category category, LogLevel the logger level level) Apply a wire logger configuration using the specified category (logger), logger level and `AdvancedBufferFormat#HEX_DUMP` for `Buffer` format, which means both events and content will be logged and the content will be in hex format.
public final T	Returns: a new `Transport` reference wiretap(String the logger category category, LogLevel the logger level level, AdvancedBufferFormat the `Buffer` format format) Apply a wire logger configuration using the specified category (logger), logger level and `Buffer` format.
public final T	Returns: a new `Transport` reference wiretap(String the logger category category, LogLevel the logger level level, AdvancedBufferFormat the `Buffer` format format, Charset the charset charset) Apply a wire logger configuration using the specific category (logger), logger level, `Buffer` format and charset.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

log	back to summary
pack-priv static final Logger log

Transport	back to summary
public Transport()

Method Detail

attr back to summary

attr	back to summary
public <A> T attr(AttributeKey<A> key, A value) Update the given attribute key or remove it if the value is null. Parameters <A> the attribute type key:AttributeKey<A> the `AttributeKey` key value:A the `AttributeKey` value Returns:T a new `Transport` reference

public <A> T attr(AttributeKey<A> key, A value)

Update the given attribute key or remove it if the value is null.

Parameters

<A>: the attribute type
key:AttributeKey<A>: the AttributeKey key
value:A: the AttributeKey value

Returns:T

a new Transport reference

bindAddress back to summary

bindAddress	back to summary
public T bindAddress(Supplier<? extends SocketAddress> bindAddressSupplier) Set a new local address to which this transport should bind on subscribe. Parameters bindAddressSupplier:Supplier<? extends SocketAddress> A supplier of the address to bind to. Returns:T a new `Transport`

public T bindAddress(Supplier<? extends SocketAddress> bindAddressSupplier)

Set a new local address to which this transport should bind on subscribe.

Parameters

bindAddressSupplier:Supplier<? extends SocketAddress>: A supplier of the address to bind to.

Returns:T

a new Transport

channelGroup back to summary

channelGroup	back to summary
public T channelGroup(ChannelGroup channelGroup) Provide a `ChannelGroup` to hold all active connected channels. Graceful Shutdown: When a `ChannelGroup` is set, calls to `DisposableChannel#disposeNow()` and `DisposableChannel#disposeNow(Duration)` not only stop accepting new requests but also additionally wait for all active requests, in the `ChannelGroup`, to complete, within the given timeout. Parameters channelGroup:ChannelGroup a `ChannelGroup` Returns:T a new `Transport` reference

public T channelGroup(ChannelGroup channelGroup)

Provide a ChannelGroup to hold all active connected channels.

Graceful Shutdown:

When a ChannelGroup is set, calls to DisposableChannel#disposeNow() and DisposableChannel#disposeNow(Duration) not only stop accepting new requests but also additionally wait for all active requests, in the ChannelGroup, to complete, within the given timeout.

Parameters

channelGroup:ChannelGroup: a ChannelGroup

Returns:T

a new Transport reference

configuration back to summary

configuration	back to summary
public abstract C configuration() Return a `TransportConfig`. Returns:C a `TransportConfig`

public abstract C configuration()

Return a TransportConfig.

Returns:C: a TransportConfig

doOnChannelInit back to summary

doOnChannelInit	back to summary
public T doOnChannelInit(ChannelPipelineConfigurer doOnChannelInit) Configure the channel pipeline while initializing the channel. Parameters doOnChannelInit:ChannelPipelineConfigurer configure the channel pipeline while initializing the channel Returns:T a new `Transport` reference

public T doOnChannelInit(ChannelPipelineConfigurer doOnChannelInit)

Configure the channel pipeline while initializing the channel.

Parameters

doOnChannelInit:ChannelPipelineConfigurer: configure the channel pipeline while initializing the channel

Returns:T

a new Transport reference

duplicate back to summary

duplicate	back to summary
protected abstract T duplicate() Return a new `Transport` inheriting the current configuration. This is a shallow copy. Returns:T a new `Transport` inheriting the current configuration

protected abstract T duplicate()

Return a new Transport inheriting the current configuration. This is a shallow copy.

Returns:T: a new Transport inheriting the current configuration

metrics back to summary

metrics	back to summary
protected T metrics(boolean enable) Whether to enable metrics to be collected and registered in Micrometer's `globalRegistry`. Applications can separately register their own `filters`. For example, to put an upper bound on the number of tags produced: MeterFilter filter = ... ; Metrics.globalRegistry.config().meterFilter(MeterFilter.maximumAllowableTags(prefix, 100, filter)); By default this is not enabled. Parameters enable:boolean true enables metrics collection; false disables it Returns:T a new `Transport` reference

protected T metrics(boolean enable)

Whether to enable metrics to be collected and registered in Micrometer's globalRegistry. Applications can separately register their own filters. For example, to put an upper bound on the number of tags produced:

MeterFilter filter = ... ;
Metrics.globalRegistry.config().meterFilter(MeterFilter.maximumAllowableTags(prefix, 100, filter));

By default this is not enabled.

Parameters

enable:boolean: true enables metrics collection; false disables it

Returns:T

a new Transport reference

metrics back to summary

metrics	back to summary
public T metrics(boolean enable, Supplier<? extends ChannelMetricsRecorder> recorder) Specifies whether the metrics are enabled on the `Transport`. All generated metrics are provided to the specified recorder which is only instantiated if metrics are being enabled (the instantiation is not lazy, but happens immediately, while configuring the `Transport`). Parameters enable:boolean if true enables the metrics on the `Transport`. recorder:Supplier<? extends ChannelMetricsRecorder> a supplier for the `ChannelMetricsRecorder` Returns:T a new `Transport` reference

public T metrics(boolean enable, Supplier<? extends ChannelMetricsRecorder> recorder)

Specifies whether the metrics are enabled on the Transport. All generated metrics are provided to the specified recorder which is only instantiated if metrics are being enabled (the instantiation is not lazy, but happens immediately, while configuring the Transport).

Parameters

enable:boolean: if true enables the metrics on the Transport.
recorder:Supplier<? extends ChannelMetricsRecorder>: a supplier for the ChannelMetricsRecorder

Returns:T

a new Transport reference

observe back to summary

observe	back to summary
public T observe(ConnectionObserver observer) Set or add the given `ConnectionObserver` to observe the connection state changes. Parameters observer:ConnectionObserver the `ConnectionObserver` to be set or add Returns:T a new `Transport` reference

public T observe(ConnectionObserver observer)

Set or add the given ConnectionObserver to observe the connection state changes.

Parameters

observer:ConnectionObserver: the ConnectionObserver to be set or add

Returns:T

a new Transport reference

option back to summary

option	back to summary
public <O> T option(ChannelOption<O> key, O value) Update the given option key or remove it if the value is null. Note Setting `ChannelOption#AUTO_READ` option will be ignored. It is configured to be `false`. Parameters <O> the option type key:ChannelOption<O> the `ChannelOption` key value:O the `ChannelOption` value or null Returns:T a new `Transport` reference Annotations @SuppressWarnings:ReferenceEquality

public <O> T option(ChannelOption<O> key, O value)

Update the given option key or remove it if the value is null.

Note

Setting ChannelOption#AUTO_READ option will be ignored. It is configured to be false.

Parameters

<O>: the option type
key:ChannelOption<O>: the ChannelOption key
value:O: the ChannelOption value or null

Returns:T

a new Transport reference

Annotations

@SuppressWarnings:ReferenceEquality

runOn back to summary

runOn	back to summary
public T runOn(EventLoopGroup eventLoopGroup) Run IO loops on the given `EventLoopGroup`. Parameters eventLoopGroup:EventLoopGroup an eventLoopGroup to share Returns:T a new `Transport` reference

public T runOn(EventLoopGroup eventLoopGroup)

Run IO loops on the given EventLoopGroup.

Parameters

eventLoopGroup:EventLoopGroup: an eventLoopGroup to share

Returns:T

a new Transport reference

runOn back to summary

runOn	back to summary
public T runOn(LoopResources channelResources) Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container. Will prefer native (epoll/kqueue) implementation if available unless the environment property `reactor.netty5.native` is set to `false`. Parameters channelResources:LoopResources a `LoopResources` accepting native runtime expectation and returning an eventLoopGroup Returns:T a new `Transport` reference

public T runOn(LoopResources channelResources)

Run IO loops on a supplied EventLoopGroup from the LoopResources container. Will prefer native (epoll/kqueue) implementation if available unless the environment property reactor.netty5.native is set to false.

Parameters

channelResources:LoopResources: a LoopResources accepting native runtime expectation and returning an eventLoopGroup

Returns:T

a new Transport reference

runOn back to summary

runOn	back to summary
public T runOn(LoopResources loopResources, boolean preferNative) Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container. Parameters loopResources:LoopResources a new loop resources preferNative:boolean should prefer running on epoll, kqueue or similar instead of java NIO Returns:T a new `Transport` reference

public T runOn(LoopResources loopResources, boolean preferNative)

Run IO loops on a supplied EventLoopGroup from the LoopResources container.

Parameters

loopResources:LoopResources: a new loop resources
preferNative:boolean: should prefer running on epoll, kqueue or similar instead of java NIO

Returns:T

a new Transport reference

runOn back to summary

runOn	back to summary
public final T runOn(LoopResources loopResources, boolean preferNative, ProtocolFamily family) Run IO loops on a supplied `EventLoopGroup` from the `LoopResources` container. Parameters loopResources:LoopResources a new loop resources preferNative:boolean should prefer running on epoll, kqueue or similar instead of java NIO family:ProtocolFamily a specific `ProtocolFamily` to run with Returns:T a new `Transport` reference

public final T runOn(LoopResources loopResources, boolean preferNative, ProtocolFamily family)

Run IO loops on a supplied EventLoopGroup from the LoopResources container.

Parameters

loopResources:LoopResources: a new loop resources
preferNative:boolean: should prefer running on epoll, kqueue or similar instead of java NIO
family:ProtocolFamily: a specific ProtocolFamily to run with

Returns:T

a new Transport reference

wiretap back to summary

wiretap	back to summary
public T wiretap(boolean enable) Apply or remove a wire logger configuration using `Transport` category (logger), `DEBUG` logger level and `AdvancedBufferFormat#HEX_DUMP` for `Buffer` format, which means both events and content will be logged and the content will be in hex format. Parameters enable:boolean specifies whether the wire logger configuration will be added to the pipeline Returns:T a new `Transport` reference

public T wiretap(boolean enable)

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

Parameters

enable:boolean: specifies whether the wire logger configuration will be added to the pipeline

Returns:T

a new Transport reference

wiretap back to summary

wiretap	back to summary
public T wiretap(String category) Apply a wire logger configuration using the specified category (logger), `DEBUG` logger level and `AdvancedBufferFormat#HEX_DUMP` for `Buffer` format, which means both events and content will be logged and the content will be in hex format. Parameters category:String the logger category Returns:T a new `Transport` reference

public T wiretap(String category)

Apply a wire logger configuration using the specified category (logger), DEBUG logger level and AdvancedBufferFormat#HEX_DUMP for Buffer format, which means both events and content will be logged and the content will be in hex format.

Parameters

category:String: the logger category

Returns:T

a new Transport reference

wiretap back to summary

wiretap	back to summary
public T wiretap(String category, LogLevel level) Apply a wire logger configuration using the specified category (logger), logger level and `AdvancedBufferFormat#HEX_DUMP` for `Buffer` format, which means both events and content will be logged and the content will be in hex format. Parameters category:String the logger category level:LogLevel the logger level Returns:T a new `Transport` reference

public T wiretap(String category, LogLevel level)

Apply a wire logger configuration using the specified category (logger), logger level and AdvancedBufferFormat#HEX_DUMP for Buffer format, which means both events and content will be logged and the content will be in hex format.

Parameters

category:String: the logger category
level:LogLevel: the logger level

Returns:T

a new Transport reference

wiretap back to summary

wiretap	back to summary
public final T wiretap(String category, LogLevel level, AdvancedBufferFormat format) Apply a wire logger configuration using the specified category (logger), logger level and `Buffer` format. Depending on the format: `AdvancedBufferFormat#SIMPLE` - only the events will be logged `AdvancedBufferFormat#HEX_DUMP` - both events and content will be logged, with content in hex format `AdvancedBufferFormat#TEXTUAL` - both events and content will be logged, with content in plain text format When `AdvancedBufferFormat#TEXTUAL` is specified, `Charset#defaultCharset()` will be used. Parameters category:String the logger category level:LogLevel the logger level format:AdvancedBufferFormat the `Buffer` format Returns:T a new `Transport` reference

public final T wiretap(String category, LogLevel level, AdvancedBufferFormat format)

Apply a wire logger configuration using the specified category (logger), logger level and Buffer format. Depending on the format:

AdvancedBufferFormat#SIMPLE - only the events will be logged
AdvancedBufferFormat#HEX_DUMP - both events and content will be logged, with content in hex format
AdvancedBufferFormat#TEXTUAL - both events and content will be logged, with content in plain text format

When AdvancedBufferFormat#TEXTUAL is specified, Charset#defaultCharset() will be used.

Parameters

category:String: the logger category
level:LogLevel: the logger level
format:AdvancedBufferFormat: the Buffer format

Returns:T

a new Transport reference

wiretap back to summary

wiretap	back to summary
public final T wiretap(String category, LogLevel level, AdvancedBufferFormat format, Charset charset) Apply a wire logger configuration using the specific category (logger), logger level, `Buffer` format and charset. The charset is relevant in case of `AdvancedBufferFormat#TEXTUAL` and a different charset than `Charset#defaultCharset()` is required. Depending on the format: `AdvancedBufferFormat#SIMPLE` - only the events will be logged `AdvancedBufferFormat#HEX_DUMP` - both events and content will be logged, with content in hex format `AdvancedBufferFormat#TEXTUAL` - both events and content will be logged, with content in plain text format Parameters category:String the logger category level:LogLevel the logger level format:AdvancedBufferFormat the `Buffer` format charset:Charset the charset Returns:T a new `Transport` reference

public final T wiretap(String category, LogLevel level, AdvancedBufferFormat format, Charset charset)

Apply a wire logger configuration using the specific category (logger), logger level, Buffer format and charset. The charset is relevant in case of AdvancedBufferFormat#TEXTUAL and a different charset than Charset#defaultCharset() is required. Depending on the format:

AdvancedBufferFormat#SIMPLE - only the events will be logged
AdvancedBufferFormat#HEX_DUMP - both events and content will be logged, with content in hex format
AdvancedBufferFormat#TEXTUAL - both events and content will be logged, with content in plain text format

Parameters

category:String: the logger category
level:LogLevel: the logger level
format:AdvancedBufferFormat: the Buffer format
charset:Charset: the charset

Returns:T

a new Transport reference

public abstract Class Transport<T extends reactor.netty5.transport.Transport<T, C>, C extends reactor.netty5.transport.TransportConfig>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail