reactor.netty.http

Class HttpOperations<INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound>

java.lang.Object

io.netty.util.concurrent.AbstractFuture<V>

io.netty.util.concurrent.DefaultPromise<Void>

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

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

All Implemented Interfaces:

ChannelFuture, ChannelPromise, Promise<Void>, Future<Void>, Publisher<Void>, Subscriber<Void>, CoreSubscriber<Void>, Disposable, Connection, DisposableChannel, HttpInfos, NettyInbound, NettyOutbound

Direct Known Subclasses:

HttpToH2Operations

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/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)
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).
boolean	hasSentHeaders() Has headers been sent
protected boolean	isKeepAlive(HttpMessage message)
boolean	isWebsocket() Returns true if websocket connection (upgraded)
protected boolean	markSentBody() Mark the body sent
protected boolean	markSentHeaderAndBody() Mark the headers and body sent
protected boolean	markSentHeaders() Mark the headers sent
protected abstract HttpMessage	newFullEmptyBodyMessage()
protected abstract HttpMessage	outboundHttpMessage() Outbound Netty HttpMessage
protected abstract void	preSendHeadersAndStatus()
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.
Mono<Void>	then() Obtains a Mono of pending outbound(s) write completion.
String	toString()

Methods inherited from class reactor.netty.channel.ChannelOperations

addListener, addListeners, addReactiveBridge, alloc, as, await, awaitUninterruptibly, channel, connection, currentContext, discard, dispose, disposeSubscriber, formatName, get, inbound, isDisposed, isInboundCancelled, isInboundDisposed, isPersistent, isVoid, listener, onComplete, onDispose, onDispose, onError, onInboundCancel, onInboundClose, onInboundComplete, onInboundError, onInboundNext, onNext, onOutboundComplete, onOutboundError, onSubscribe, onTerminate, outbound, receive, receiveObject, removeListener, removeListeners, sendObject, sendObject, sendUsing, setFailure, setSuccess, setSuccess, sync, syncUninterruptibly, terminate, tryFailure, trySuccess, unvoid, withConnection

Methods inherited from class io.netty.util.concurrent.DefaultPromise

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, checkDeadLock, executor, getNow, isCancellable, isCancelled, isDone, isSuccess, notifyListener, setUncancellable, toStringBuilder, trySuccess

Methods inherited from class io.netty.util.concurrent.AbstractFuture

get, get

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, isKeepAlive, method, path, uri, version

Methods inherited from interface reactor.netty.NettyOutbound

neverComplete, options, send, sendByteArray, sendFile, sendFileChunked, sendGroups, sendString, sendString, subscribe, 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

Methods inherited from interface io.netty.util.concurrent.Promise

setUncancellable, trySuccess

Methods inherited from interface io.netty.util.concurrent.Future

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, getNow, isCancellable, isSuccess

Methods inherited from interface java.util.concurrent.Future

get, get, isCancelled, isDone

Constructor Detail

HttpOperations

protected HttpOperations(HttpOperations<INBOUND,OUTBOUND> replaced)

HttpOperations

protected HttpOperations(Connection connection,
                         ConnectionObserver listener)

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

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

preSendHeadersAndStatus

protected abstract void preSendHeadersAndStatus()

newFullEmptyBodyMessage

protected abstract HttpMessage newFullEmptyBodyMessage()

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).

Specified by:

addHandler in interface Connection

Parameters:

name - handler name

handler - handler instance

Returns:

this Connection

markSentHeaders

protected final boolean markSentHeaders()

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()

Mark the headers and body sent

Returns:

true if marked for the first time

isKeepAlive

protected boolean isKeepAlive(HttpMessage message)

outboundHttpMessage

protected abstract HttpMessage outboundHttpMessage()

Outbound Netty HttpMessage

Returns:

Outbound Netty HttpMessage