reactor.netty.http

Class HttpOperations<INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound>

java.lang.Object

reactor.netty.channel.ChannelOperations<INBOUND,OUTBOUND>

reactor.netty.http.HttpOperations<INBOUND,OUTBOUND>

All Implemented Interfaces:

Publisher<Void>, Subscriber<Void>, CoreSubscriber<Void>, Disposable, ChannelOperationsId, Connection, DisposableChannel, HttpInfos, NettyInbound, NettyOutbound

public abstract class HttpOperations<INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound>
extends ChannelOperations<INBOUND,OUTBOUND>
implements HttpInfos

An HTTP ready ChannelOperations with state management for status and headers (first HTTP response packet).

Author:

Stephane Maldini

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HttpOperations.PostHeadersNettyOutbound

Nested classes/interfaces inherited from class reactor.netty.channel.ChannelOperations

ChannelOperations.OnSetup

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpOperations(Connection connection, ConnectionObserver listener, HttpMessageLogFactory httpMessageLogFactory)
protected	HttpOperations(HttpOperations<INBOUND,OUTBOUND> replaced)

Method Summary

Modifier and Type	Method and Description
HttpOperations<INBOUND,OUTBOUND>	addHandler(String name, ChannelHandler handler) Add a ChannelHandler with Connection.addHandlerFirst(io.netty.channel.ChannelHandler) if of type of ChannelOutboundHandler otherwise with Connection.addHandlerLast(io.netty.channel.ChannelHandler).
protected abstract void	afterMarkSentHeaders()
protected String	asDebugLogMessage(Object o) Transforms the object to a string for debug logs.
protected abstract void	beforeMarkSentHeaders()
boolean	hasSentHeaders() Has headers been sent
protected HttpMessageLogFactory	httpMessageLogFactory()
protected String	initShortId()
protected abstract boolean	isContentAlwaysEmpty()
boolean	isWebsocket() Returns true if websocket connection (upgraded)
protected boolean	markSentBody() Mark the body sent
protected boolean	markSentHeaderAndBody(Object... objectsToRelease) Mark the headers and body sent
protected boolean	markSentHeaders(Object... objectsToRelease) Mark the headers sent
protected abstract HttpMessage	newFullBodyMessage(ByteBuf body)
protected abstract void	onHeadersSent()
protected abstract HttpMessage	outboundHttpMessage() Outbound Netty HttpMessage
String	requestId() Return a unique id for the request.
static String	resolvePath(String uri) Returns the decoded path portion from the provided uri
NettyOutbound	send(Publisher<? extends ByteBuf> source) Sends data to the peer, listens for any error on write and closes on terminal signal (complete|error).
NettyOutbound	sendFile(Path file, long position, long count) Sends content from the given Path using FileChannel.transferTo(long, long, WritableByteChannel) support, if the system supports it, the path resolves to a local file system File, compression and SSL/TLS is not enabled, then transfer will use zero-byte copy to the peer., otherwise chunked read/write will be used.
NettyOutbound	sendObject(Object message) Sends data to the peer, listens for any error on write and closes on terminal signal (complete|error).
Mono<Void>	then() Obtains a Mono of pending outbound(s) write completion.
String	toString()

Methods inherited from class reactor.netty.channel.ChannelOperations

addMetricsHandler, addReactiveBridge, afterInboundComplete, alloc, as, asLongText, asShortText, channel, connection, currentContext, discard, discardWhenNoReceiver, dispose, disposeSubscriber, formatName, get, inbound, isDisposed, isInboundCancelled, isInboundDisposed, isPersistent, isSubscriptionDisposed, listener, onComplete, onDispose, onDispose, onError, onInboundCancel, onInboundClose, onInboundComplete, onInboundError, onInboundNext, onNext, onOutboundComplete, onOutboundError, onSubscribe, onTerminate, outbound, receive, receiveObject, send, sendObject, sendUsing, terminate, withConnection, wrapInboundError

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.netty.http.HttpInfos

cookies, fullPath, isKeepAlive, method, path, uri, version

Methods inherited from interface reactor.netty.NettyOutbound

neverComplete, sendByteArray, sendFile, sendFileChunked, sendGroups, sendObject, sendString, sendString, subscribe, then, then

Methods inherited from interface reactor.netty.Connection

addHandler, addHandlerFirst, addHandlerFirst, addHandlerLast, addHandlerLast, bind, from, markPersistent, onReadIdle, onWriteIdle, rebind, removeHandler, replaceHandler

Methods inherited from interface reactor.netty.DisposableChannel

address, disposeNow, disposeNow

Constructor Detail

HttpOperations

protected HttpOperations(HttpOperations<INBOUND,OUTBOUND> replaced)

HttpOperations

protected HttpOperations(Connection connection,
                         ConnectionObserver listener,
                         HttpMessageLogFactory httpMessageLogFactory)

Method Detail

hasSentHeaders

public final boolean hasSentHeaders()

Has headers been sent

Returns:

true if headers have been sent

isWebsocket

public boolean isWebsocket()

Description copied from interface: HttpInfos

Returns true if websocket connection (upgraded)

Specified by:

isWebsocket in interface HttpInfos

Returns:

true if websocket connection

requestId

public String requestId()

Description copied from interface: HttpInfos

Return a unique id for the request. The id is a combination of the id of the underlying connection and the serial number of the request received on that connection.

Format of the id: <CONNECTION_ID>-<REQUEST_NUMBER>

Example: <CONNECTION_ID>: 329c6ffd <REQUEST_NUMBER>: 5 Result: 329c6ffd-5

Specified by:

requestId in interface HttpInfos

Returns:

an unique id for the request

send

public NettyOutbound send(Publisher<? extends ByteBuf> source)

Description copied from interface: NettyOutbound

Sends data to the peer, listens for any error on write and closes on terminal signal (complete|error).

A new NettyOutbound type (or the same) for typed send sequences.

Note: Nesting any send* method is not supported.

Specified by:

send in interface NettyOutbound

Parameters:

source - the dataStream publishing OUT items to write on this channel

Returns:

A new NettyOutbound to append further send. It will emit a complete signal successful sequence write (e.g. after "flush") or any error during write.

sendObject

public NettyOutbound sendObject(Object message)

Description copied from interface: NettyOutbound

Sends data to the peer, listens for any error on write and closes on terminal signal (complete|error).

Note: Nesting any send* method is not supported.

Specified by:

sendObject in interface NettyOutbound

Overrides:

sendObject in class ChannelOperations<INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound>

Parameters:

message - the object to publish

Returns:

A Mono to signal successful sequence write (e.g. after "flush") or any error during write

then

public Mono<Void> then()

Description copied from interface: NettyOutbound

Obtains a Mono of pending outbound(s) write completion.

Specified by:

then in interface NettyOutbound

Returns:

a Mono of pending outbound(s) write completion

asDebugLogMessage

protected String asDebugLogMessage(Object o)

Description copied from class: ChannelOperations

Transforms the object to a string for debug logs.

Overrides:

asDebugLogMessage in class ChannelOperations<INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound>

Parameters:

o - the object to be transformed

Returns:

the string to be logged

httpMessageLogFactory

protected HttpMessageLogFactory httpMessageLogFactory()

beforeMarkSentHeaders

protected abstract void beforeMarkSentHeaders()

afterMarkSentHeaders

protected abstract void afterMarkSentHeaders()

isContentAlwaysEmpty

protected abstract boolean isContentAlwaysEmpty()

onHeadersSent

protected abstract void onHeadersSent()

newFullBodyMessage

protected abstract HttpMessage newFullBodyMessage(ByteBuf body)

sendFile

public final NettyOutbound sendFile(Path file,
                                    long position,
                                    long count)

Description copied from interface: NettyOutbound

Sends content from the given Path using FileChannel.transferTo(long, long, WritableByteChannel) support, if the system supports it, the path resolves to a local file system File, compression and SSL/TLS is not enabled, then transfer will use zero-byte copy to the peer., otherwise chunked read/write will be used.

It will listens for any error on write and closes on terminal signal (complete|error). If more than one publisher is attached (multiple calls to send()) completion occurs after all publishers complete.

Note: Nesting any send* method is not supported.

Specified by:

sendFile in interface NettyOutbound

Parameters:

file - the file Path

position - where to start

count - how much to transfer

Returns:

A Publisher to signal successful sequence write (e.g. after "flush") or any error during write

toString

public String toString()

Overrides:

toString in class ChannelOperations<INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound>

addHandler

public HttpOperations<INBOUND,OUTBOUND> addHandler(String name,
                                                   ChannelHandler handler)

Description copied from interface: Connection

Add a ChannelHandler with Connection.addHandlerFirst(io.netty.channel.ChannelHandler) if of type of ChannelOutboundHandler otherwise with Connection.addHandlerLast(io.netty.channel.ChannelHandler). Implementation may add more auto handling in particular HTTP based context will prepend an HttpContent body extractor.

[ [reactor codecs], [<- user FIRST HANDLERS added here, user LAST HANDLERS added here ->], [reactor handlers] ]

If effectively added, the handler will be safely removed when the channel is made inactive (pool release). As the Connection object is available once the channel is in active state, events prior this state will not be available (i.e. channelRegistered, initChannel, channelActive, etc.)

Specified by:

addHandler in interface Connection

Parameters:

name - handler name

handler - handler instance

Returns:

this Connection

markSentHeaders

protected final boolean markSentHeaders(Object... objectsToRelease)

Mark the headers sent

Returns:

true if marked for the first time

markSentBody

protected final boolean markSentBody()

Mark the body sent

Returns:

true if marked for the first time

markSentHeaderAndBody

protected final boolean markSentHeaderAndBody(Object... objectsToRelease)

Mark the headers and body sent

Returns:

true if marked for the first time

initShortId

protected final String initShortId()

Overrides:

initShortId in class ChannelOperations<INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound>

resolvePath

public static String resolvePath(String uri)

Returns the decoded path portion from the provided uri

Parameters:

uri - an HTTP URL that may contain a path with query/fragment

Returns:

the decoded path portion from the provided uri

outboundHttpMessage

protected abstract HttpMessage outboundHttpMessage()

Outbound Netty HttpMessage

Returns:

Outbound Netty HttpMessage