Package org.omegazero.http.util

Class AbstractHTTPMessageStream

java.lang.Object

org.omegazero.http.util.AbstractHTTPMessageStream

All Implemented Interfaces:

Closeable, AutoCloseable, HTTPMessageStream

Direct Known Subclasses:

AbstractHTTPClientStream, AbstractHTTPServerStream

public abstract class AbstractHTTPMessageStream
extends Object
implements HTTPMessageStream

A HTTPMessageStream with several basic methods implemented.

Since:

1.4.1

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	closed
protected Consumer<Exception>	onError
protected Runnable	onWritable
protected final HTTPRequest	request

Constructor Summary

Constructors

Constructor	Description
AbstractHTTPMessageStream(HTTPRequest request)	Creates a new AbstractHTTPMessageStream.

Method Summary

Modifier and Type	Method	Description
void	callOnError(Exception err)	Calls the onError callback.
void	callOnWritable()	Calls the onWritable callback.
HTTPRequest	getRequest()	Returns the request of this HTTPMessageStream.
protected void	internalError(Exception e)	Called when a callback handler throws an exception.
boolean	isClosed()	Returns true if this HTTPMessageStream has closed, either forcibly (via HTTPMessageStream.close()) or because the request transaction has completed.
void	onError(Consumer<Exception> onError)	Sets a callback that is called when this HTTPMessageStream encounters a fatal error.
void	onWritable(Runnable onWritable)	Sets a callback that is called when this HTTPMessageStream has cleared its write buffer after a sendData call returned false.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.omegazero.http.util.HTTPMessageStream

close, close, setReceiveData

Field Details

request

protected final HTTPRequest request

closed

protected boolean closed

onWritable

protected Runnable onWritable

onError

protected Consumer<Exception> onError

Constructor Details

AbstractHTTPMessageStream

public AbstractHTTPMessageStream(HTTPRequest request)

Creates a new AbstractHTTPMessageStream.

Parameters:

request - The request

Method Details

internalError

protected void internalError(Exception e)

Called when a callback handler throws an exception. Calls the onError callback and closes this stream with reason INTERNAL_ERROR.

Parameters:

e - The exception thrown by the callback handler

callOnWritable

public void callOnWritable()

Calls the onWritable callback.

callOnError

public void callOnError(Exception err)

Calls the onError callback.

Parameters:

err - The object to pass to the callback

getRequest

public HTTPRequest getRequest()

Description copied from interface: HTTPMessageStream

Returns the request of this HTTPMessageStream.

Specified by:

getRequest in interface HTTPMessageStream

Returns:

The request

onWritable

public void onWritable(Runnable onWritable)

Description copied from interface: HTTPMessageStream

Sets a callback that is called when this HTTPMessageStream has cleared its write buffer after a sendData call returned false.

Specified by:

onWritable in interface HTTPMessageStream

Parameters:

onWritable - The callback

onError

public void onError(Consumer<Exception> onError)

Description copied from interface: HTTPMessageStream

Sets a callback that is called when this HTTPMessageStream encounters a fatal error. This includes exceptions thrown by other callback handlers. Usually, this HTTPMessageStream is closed after this callback is called.

Specified by:

onError in interface HTTPMessageStream

Parameters:

onError - The callback

isClosed

public boolean isClosed()

Description copied from interface: HTTPMessageStream

Returns true if this HTTPMessageStream has closed, either forcibly (via HTTPMessageStream.close()) or because the request transaction has completed.

Specified by:

isClosed in interface HTTPMessageStream

Returns:

true if closed