Class HttpSender

java.lang.Object

org.eclipse.jetty.client.HttpSender

All Implemented Interfaces:

EventListener, AsyncContentProvider.Listener

Direct Known Subclasses:

HttpSenderOverFCGI, HttpSenderOverHTTP

public abstract class HttpSender
extends Object
implements AsyncContentProvider.Listener

HttpSender abstracts the algorithm to send HTTP requests, so that subclasses only implement the transport-specific code to send requests over the wire, implementing sendHeaders(HttpExchange, HttpContent, Callback) and sendContent(HttpExchange, HttpContent, Callback).

HttpSender governs two state machines.

The request state machine is updated by HttpSender as the various steps of sending a request are executed, see RequestState. At any point in time, a user thread may abort the request, which may (if the request has not been completely sent yet) move the request state machine to RequestState#FAILURE. The request state machine guarantees that the request steps are executed (by I/O threads) only if the request has not been failed already.

The sender state machine is updated by HttpSender from three sources: deferred content notifications (via onContent()), 100-continue notifications (via proceed(HttpExchange, Throwable)) and normal request send (via sendContent(HttpExchange, HttpContent, Callback)). This state machine must guarantee that the request sending is never executed concurrently: only one of those sources may trigger the call to sendContent(HttpExchange, HttpContent, Callback).

See Also:

• HttpReceiver

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	HttpSender.CommitCallback
private class	HttpSender.ContentCallback
private class	HttpSender.LastCallback
private static enum	HttpSender.RequestState	The request states HttpSender goes through when sending a request.
private static enum	HttpSender.SenderState	The sender states HttpSender goes through when sending a request.

Field Summary

Fields

Modifier and Type	Field	Description
private final HttpChannel	channel
private final Callback	commitCallback
private HttpContent	content
private final IteratingCallback	contentCallback
private Throwable	failure
private final Callback	lastCallback
protected static final Logger	LOG
private final AtomicReference<HttpSender.RequestState>	requestState
private final AtomicReference<HttpSender.SenderState>	senderState

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HttpSender(HttpChannel channel)

Method Summary

Modifier and Type	Method	Description
boolean	abort(HttpExchange exchange, Throwable failure)
private void	anyToFailure(Throwable failure)
protected boolean	beginToHeaders(HttpExchange exchange)
protected void	dispose()
private void	executeAbort(HttpExchange exchange, Throwable failure)
protected boolean	expects100Continue(Request request)
protected HttpChannel	getHttpChannel()
protected HttpExchange	getHttpExchange()
protected boolean	headersToCommit(HttpExchange exchange)
private void	illegalSenderState(HttpSender.SenderState current)
boolean	isFailed()
void	onContent()	Callback method invoked when content is available
void	proceed(HttpExchange exchange, Throwable failure)
protected boolean	queuedToBegin(HttpExchange exchange)
protected void	reset()
void	send(HttpExchange exchange)
protected abstract void	sendContent(HttpExchange exchange, HttpContent content, Callback callback)	Implementations should send the content at the HttpContent cursor position over the wire.
protected abstract void	sendHeaders(HttpExchange exchange, HttpContent content, Callback callback)	Implementations should send the HTTP headers over the wire, possibly with some content, in a single write, and notify the given callback of the result of this operation.
protected boolean	someToContent(HttpExchange exchange, ByteBuffer content)
protected boolean	someToSuccess(HttpExchange exchange)
private void	terminateRequest(HttpExchange exchange)
private void	terminateRequest(HttpExchange exchange, Throwable failure, Result result)
String	toString()
private boolean	updateRequestState(HttpSender.RequestState from, HttpSender.RequestState to)
private boolean	updateSenderState(HttpSender.SenderState from, HttpSender.SenderState to)

Methods inherited from class Object

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

Field Details

LOG

protected static final Logger LOG

requestState

private final AtomicReference<HttpSender.RequestState> requestState

senderState

private final AtomicReference<HttpSender.SenderState> senderState

commitCallback

private final Callback commitCallback

contentCallback

private final IteratingCallback contentCallback

lastCallback

private final Callback lastCallback

channel

private final HttpChannel channel

content

private HttpContent content

failure

private Throwable failure

Constructor Details

HttpSender

protected HttpSender(HttpChannel channel)

Method Details

getHttpChannel

protected HttpChannel getHttpChannel()

getHttpExchange

protected HttpExchange getHttpExchange()

isFailed

public boolean isFailed()

onContent

public void onContent()

Description copied from interface: AsyncContentProvider.Listener

Callback method invoked when content is available

Specified by:

onContent in interface AsyncContentProvider.Listener

send

public void send(HttpExchange exchange)

expects100Continue

protected boolean expects100Continue(Request request)

queuedToBegin

protected boolean queuedToBegin(HttpExchange exchange)

beginToHeaders

protected boolean beginToHeaders(HttpExchange exchange)

headersToCommit

protected boolean headersToCommit(HttpExchange exchange)

someToContent

protected boolean someToContent(HttpExchange exchange,
 ByteBuffer content)

someToSuccess

protected boolean someToSuccess(HttpExchange exchange)

anyToFailure

private void anyToFailure(Throwable failure)

executeAbort

private void executeAbort(HttpExchange exchange,
 Throwable failure)

terminateRequest

private void terminateRequest(HttpExchange exchange)

terminateRequest

private void terminateRequest(HttpExchange exchange,
 Throwable failure,
 Result result)

sendHeaders

protected abstract void sendHeaders(HttpExchange exchange,
 HttpContent content,
 Callback callback)

Implementations should send the HTTP headers over the wire, possibly with some content, in a single write, and notify the given callback of the result of this operation.

If there is more content to send, then sendContent(HttpExchange, HttpContent, Callback) will be invoked.

Parameters:

exchange - the exchange to send

content - the content to send

callback - the callback to notify

sendContent

protected abstract void sendContent(HttpExchange exchange,
 HttpContent content,
 Callback callback)

Implementations should send the content at the HttpContent cursor position over the wire.

The HttpContent cursor is advanced by HttpSender at the right time, and if more content needs to be sent, this method is invoked again; subclasses need only to send the content at the HttpContent cursor position.

This method is invoked one last time when HttpContent.isConsumed() is true and therefore there is no actual content to send. This is done to allow subclasses to write "terminal" bytes (such as the terminal chunk when the transfer encoding is chunked) if their protocol needs to.

Parameters:

exchange - the exchange to send

content - the content to send

callback - the callback to notify

reset

protected void reset()

dispose

protected void dispose()

proceed

public void proceed(HttpExchange exchange,
 Throwable failure)

abort

public boolean abort(HttpExchange exchange,
 Throwable failure)

updateRequestState

private boolean updateRequestState(HttpSender.RequestState from,
 HttpSender.RequestState to)

updateSenderState

private boolean updateSenderState(HttpSender.SenderState from,
 HttpSender.SenderState to)

illegalSenderState

private void illegalSenderState(HttpSender.SenderState current)

toString

public String toString()

Overrides:

toString in class Object