io.reactivex.netty.pipeline

Class PipelineConfigurators

java.lang.Object

io.reactivex.netty.pipeline.PipelineConfigurators

public final class PipelineConfigurators
extends java.lang.Object

Utility class that provides a variety of PipelineConfigurator implementations

Method Summary

Modifier and Type	Method and Description
static <I,O> PipelineConfigurator<I,O>	appendLoggingConfigurator(PipelineConfigurator<I,O> existing, io.netty.handler.logging.LogLevel logLevel) Enables wire level logs (all events received by netty) to be logged at the passed logLevel.
static PipelineConfigurator<byte[],byte[]>	byteArrayConfigurator()
static <I> PipelineConfigurator<HttpClientResponse<ServerSentEvent>,HttpClientRequest<I>>	clientSseConfigurator()
static <I,O> PipelineConfigurator<I,O>	composeConfigurators(PipelineConfigurator<I,O> existing, PipelineConfigurator<I,O> additional) Creates a new PipelineConfiguratorComposite for both the passed configurators.
static <I,O> PipelineConfigurator<I,O>	createClientConfigurator(PipelineConfigurator<I,O> pipelineConfigurator, RxClient.ClientConfig clientConfig)
static <I,O> PipelineConfigurator<I,O>	createClientConfigurator(PipelineConfigurator<I,O> pipelineConfigurator, RxClient.ClientConfig clientConfig, MetricEventsSubject<ClientMetricsEvent<?>> eventsSubject)
static PipelineConfigurator<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf>	empty()
static <I,O> PipelineConfigurator<HttpClientResponse<O>,HttpClientRequest<I>>	httpClientConfigurator()
static <I,O> PipelineConfigurator<HttpServerRequest<I>,HttpServerResponse<O>>	httpServerConfigurator()
static <I> PipelineConfigurator<HttpServerRequest<I>,HttpServerResponse<ServerSentEvent>>	serveSseConfigurator()
static <I> PipelineConfigurator<HttpClientResponse<ServerSentEvent>,HttpClientRequest<I>>	sseClientConfigurator() Deprecated. Use clientSseConfigurator() instead.
static <I> PipelineConfigurator<HttpServerRequest<I>,HttpServerResponse<ServerSentEvent>>	sseServerConfigurator() Deprecated. Use serveSseConfigurator() instead.
static <I,O> PipelineConfigurator<I,O>	sslConfigurator(SSLEngineFactory sslEngineFactory)
static PipelineConfigurator<java.lang.String,java.lang.String>	stringMessageConfigurator()
static PipelineConfigurator<java.lang.String,java.lang.String>	textOnlyConfigurator()
static PipelineConfigurator<java.lang.String,java.lang.String>	textOnlyConfigurator(java.nio.charset.Charset inputCharset, java.nio.charset.Charset outputCharset)
static <I,O> PipelineConfigurator<I,O>	wireLoggingConfigurator(io.netty.handler.logging.LogLevel wireLogginLevel) Enables wire level logs (all events received by netty) to be logged at the passed wireLogginLevel.

Methods inherited from class java.lang.Object

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

Method Detail

byteArrayConfigurator

public static PipelineConfigurator<byte[],byte[]> byteArrayConfigurator()

textOnlyConfigurator

public static PipelineConfigurator<java.lang.String,java.lang.String> textOnlyConfigurator()

textOnlyConfigurator

public static PipelineConfigurator<java.lang.String,java.lang.String> textOnlyConfigurator(java.nio.charset.Charset inputCharset,
                                                                                           java.nio.charset.Charset outputCharset)

stringMessageConfigurator

public static PipelineConfigurator<java.lang.String,java.lang.String> stringMessageConfigurator()

httpServerConfigurator

public static <I,O> PipelineConfigurator<HttpServerRequest<I>,HttpServerResponse<O>> httpServerConfigurator()

httpClientConfigurator

public static <I,O> PipelineConfigurator<HttpClientResponse<O>,HttpClientRequest<I>> httpClientConfigurator()

clientSseConfigurator

public static <I> PipelineConfigurator<HttpClientResponse<ServerSentEvent>,HttpClientRequest<I>> clientSseConfigurator()

serveSseConfigurator

public static <I> PipelineConfigurator<HttpServerRequest<I>,HttpServerResponse<ServerSentEvent>> serveSseConfigurator()

sseClientConfigurator

@Deprecated
public static <I> PipelineConfigurator<HttpClientResponse<ServerSentEvent>,HttpClientRequest<I>> sseClientConfigurator()

Deprecated. Use clientSseConfigurator() instead.

sseServerConfigurator

@Deprecated
public static <I> PipelineConfigurator<HttpServerRequest<I>,HttpServerResponse<ServerSentEvent>> sseServerConfigurator()

Deprecated. Use serveSseConfigurator() instead.

sslConfigurator

public static <I,O> PipelineConfigurator<I,O> sslConfigurator(SSLEngineFactory sslEngineFactory)

appendLoggingConfigurator

public static <I,O> PipelineConfigurator<I,O> appendLoggingConfigurator(PipelineConfigurator<I,O> existing,
                                                                        io.netty.handler.logging.LogLevel logLevel)

Enables wire level logs (all events received by netty) to be logged at the passed logLevel. This adds a PipelineConfigurator as returned by wireLoggingConfigurator(LogLevel) to the returned configurator.
Since, in most of the production systems, the logging level is set to LogLevel.WARN or LogLevel.ERROR, if this wire level logging is required for all requests (not at all recommended as this logging is very verbose), the passed level must be LogLevel.WARN or LogLevel.ERROR respectively.
It is recommended to set this level to LogLevel.DEBUG and then dynamically enabled disable this log level whenever required.

Parameters:

logLevel - Log level at which the wire level logs will be logged.

Returns:

This builder.

See Also:

LoggingHandler

composeConfigurators

public static <I,O> PipelineConfigurator<I,O> composeConfigurators(PipelineConfigurator<I,O> existing,
                                                                   PipelineConfigurator<I,O> additional)

Creates a new PipelineConfiguratorComposite for both the passed configurators.
The only real convenience is that the existing configurator can be null.

Parameters:

existing - Existing configurator. Can be null

additional - Additional configurator. Can not be null

Returns:

Composite configurator.

Throws:

java.lang.NullPointerException - If the passed existing configurator is null.

wireLoggingConfigurator

public static <I,O> PipelineConfigurator<I,O> wireLoggingConfigurator(io.netty.handler.logging.LogLevel wireLogginLevel)

Enables wire level logs (all events received by netty) to be logged at the passed wireLogginLevel.
Since, in most of the production systems, the logging level is set to LogLevel.WARN or LogLevel.ERROR, if this wire level logging is required for all requests (not at all recommended as this logging is very verbose), the passed level must be LogLevel.WARN or LogLevel.ERROR respectively.
It is recommended to set this level to LogLevel.DEBUG and then dynamically enabled disable this log level whenever required.

Parameters:

wireLogginLevel - Log level at which the wire level logs will be logged.

Returns:

This builder.

See Also:

LoggingHandler

createClientConfigurator

public static <I,O> PipelineConfigurator<I,O> createClientConfigurator(PipelineConfigurator<I,O> pipelineConfigurator,
                                                                       RxClient.ClientConfig clientConfig)

createClientConfigurator

public static <I,O> PipelineConfigurator<I,O> createClientConfigurator(PipelineConfigurator<I,O> pipelineConfigurator,
                                                                       RxClient.ClientConfig clientConfig,
                                                                       MetricEventsSubject<ClientMetricsEvent<?>> eventsSubject)

empty

public static PipelineConfigurator<io.netty.buffer.ByteBuf,io.netty.buffer.ByteBuf> empty()