Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	WriteFlusher.CompletingState In CompletingState WriteFlusher is flushing buffers that have not been fully written in write().
private static class	WriteFlusher.FailedState In FailedState no more operations are allowed.
private static class	WriteFlusher.IdleState In IdleState WriteFlusher is idle and accepts new writes
public static interface	WriteFlusher.Listener A listener of `WriteFlusher` events.
private class	WriteFlusher.PendingState In PendingState not all buffers could be written in one go.
private static class	WriteFlusher.State State represents a State of WriteFlusher.
private static enum	WriteFlusher.StateType
private static class	WriteFlusher.WritingState In WritingState WriteFlusher is currently writing.

Field Summary

Modifier and Type	Field and Description
private static final WriteFlusher.State	__COMPLETING
private static final WriteFlusher.State	__IDLE
private static final EnumMap<WriteFlusher.StateType, Set<WriteFlusher.StateType>>	__stateTransitions
private static final WriteFlusher.State	__WRITING
private final EndPoint	_endPoint
private final AtomicReference<WriteFlusher.State>	_state
private static final boolean	DEBUG
private static final ByteBuffer[]	EMPTY_BUFFERS
private static final Logger	LOG

Constructor Summary

Access	Constructor and Description
protected	WriteFlusher(EndPoint endPoint)

Method Summary

Modifier and Type	Method and Description
public void	completeWrite() Complete a write that has not completed and that called `onIncompleteFlush()` to request a call to this method when a call to `EndPoint#flush(ByteBuffer...)` is likely to be able to progress.
private void	fail(Callback callback, Throwable... suppressed)
protected ByteBuffer[]	Returns: The unflushed buffers, or null if all flushed flush(SocketAddress the datagram channel to send the buffers to (used by QUIC and HTTP/3) address, ByteBuffer[] The buffers to flush buffers) Flushes the buffers iteratively until no progress is made.
public Invocable.InvocationType	getCallbackInvocationType()
pack-priv boolean	isFailed()
pack-priv boolean	isIdle()
public boolean	isPending()
private boolean	isState(WriteFlusher.StateType type)
private boolean	isTransitionAllowed(WriteFlusher.State currentState, WriteFlusher.State newState)
public void	onClose()
public boolean	Returns: true if the flusher passed the failure to a `Callback` instance onFail(Throwable The cause of the failure cause) Notify the flusher of a failure
protected abstract void	onIncompleteFlush() Abstract call to be implemented by specific WriteFlushers.
public String	toStateString()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private boolean	Returns: the previous state or null if the state transition failed updateState(WriteFlusher.State the expected current state previous, WriteFlusher.State the desired new state next) Tries to update the current state to the given new state.
public void	write(Callback the callback to call on either failed or complete callback, ByteBuffer... the buffers to flush to the endpoint buffers) Tries to switch state to WRITING.
public void	write(Callback callback, SocketAddress address, ByteBuffer... buffers)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

__COMPLETING	back to summary
private static final WriteFlusher.State __COMPLETING

__IDLE	back to summary
private static final WriteFlusher.State __IDLE

__stateTransitions	back to summary
private static final EnumMap<WriteFlusher.StateType, Set<WriteFlusher.StateType>> __stateTransitions

__WRITING	back to summary
private static final WriteFlusher.State __WRITING

_endPoint	back to summary
private final EndPoint _endPoint

_state	back to summary
private final AtomicReference<WriteFlusher.State> _state

DEBUG	back to summary
private static final boolean DEBUG

EMPTY_BUFFERS	back to summary
private static final ByteBuffer[] EMPTY_BUFFERS

LOG	back to summary
private static final Logger LOG

Constructor Detail

WriteFlusher	back to summary
protected WriteFlusher(EndPoint endPoint)

Method Detail

completeWrite back to summary

completeWrite	back to summary
public void completeWrite() Complete a write that has not completed and that called `onIncompleteFlush()` to request a call to this method when a call to `EndPoint#flush(ByteBuffer...)` is likely to be able to progress. It tries to switch from PENDING to COMPLETING. If state transition fails, then it does nothing as the callback should have been already failed. That's because the only way to switch from PENDING outside this method is `onFail(Throwable)` or `onClose()`

public void completeWrite()

Complete a write that has not completed and that called onIncompleteFlush() to request a call to this method when a call to EndPoint#flush(ByteBuffer...) is likely to be able to progress. It tries to switch from PENDING to COMPLETING. If state transition fails, then it does nothing as the callback should have been already failed. That's because the only way to switch from PENDING outside this method is onFail(Throwable) or onClose()

fail	back to summary
private void fail(Callback callback, Throwable... suppressed)

flush	back to summary
protected ByteBuffer[] flush(SocketAddress address, ByteBuffer[] buffers) throws IOException Flushes the buffers iteratively until no progress is made. Parameters address:SocketAddress the datagram channel to send the buffers to (used by QUIC and HTTP/3) buffers:ByteBuffer[] The buffers to flush Returns:ByteBuffer[] The unflushed buffers, or null if all flushed Exceptions IOException: if unable to flush

flush

back to summary

protected ByteBuffer[] flush(SocketAddress address, ByteBuffer[] buffers) throws IOException

Flushes the buffers iteratively until no progress is made.

Parameters

address:SocketAddress: the datagram channel to send the buffers to (used by QUIC and HTTP/3)
buffers:ByteBuffer[]: The buffers to flush

Returns:ByteBuffer[]

The unflushed buffers, or null if all flushed

Exceptions

IOException:: if unable to flush

getCallbackInvocationType	back to summary
public Invocable.InvocationType getCallbackInvocationType()

isFailed	back to summary
pack-priv boolean isFailed()

isIdle	back to summary
pack-priv boolean isIdle()

isPending	back to summary
public boolean isPending()

isState	back to summary
private boolean isState(WriteFlusher.StateType type)

isTransitionAllowed	back to summary
private boolean isTransitionAllowed(WriteFlusher.State currentState, WriteFlusher.State newState)

onClose	back to summary
public void onClose()

onFail back to summary

onFail	back to summary
public boolean onFail(Throwable cause) Notify the flusher of a failure Parameters cause:Throwable The cause of the failure Returns:boolean true if the flusher passed the failure to a `Callback` instance

public boolean onFail(Throwable cause)

Notify the flusher of a failure

Parameters

cause:Throwable: The cause of the failure

Returns:boolean

true if the flusher passed the failure to a Callback instance

onIncompleteFlush	back to summary
protected abstract void onIncompleteFlush() Abstract call to be implemented by specific WriteFlushers. It should schedule a call to `completeWrite()` or `onFail(Throwable)` when appropriate.

toStateString	back to summary
public String toStateString()

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

updateState	back to summary
private boolean updateState(WriteFlusher.State previous, WriteFlusher.State next) Tries to update the current state to the given new state. Parameters previous:WriteFlusher.State the expected current state next:WriteFlusher.State the desired new state Returns:boolean the previous state or null if the state transition failed Exceptions IllegalStateException: if previous to next is not a legal state transition (api usage error)

updateState

back to summary

private boolean updateState(WriteFlusher.State previous, WriteFlusher.State next)

Tries to update the current state to the given new state.

Parameters

previous:WriteFlusher.State: the expected current state
next:WriteFlusher.State: the desired new state

Returns:boolean

the previous state or null if the state transition failed

Exceptions

IllegalStateException:: if previous to next is not a legal state transition (api usage error)

write back to summary

write	back to summary
public void write(Callback callback, ByteBuffer... buffers) throws WritePendingException Tries to switch state to WRITING. If successful it writes the given buffers to the EndPoint. If state transition fails it will fail the callback and leave the WriteFlusher in a terminal FAILED state. If not all buffers can be written in one go it creates a new `PendingState` object to preserve the state and then calls `onIncompleteFlush()`. The remaining buffers will be written in `completeWrite()`. If all buffers have been written it calls callback.complete(). Parameters callback:Callback the callback to call on either failed or complete buffers:ByteBuffer[] the buffers to flush to the endpoint Exceptions WritePendingException: if unable to write due to prior pending write

public void write(Callback callback, ByteBuffer... buffers) throws WritePendingException

Tries to switch state to WRITING. If successful it writes the given buffers to the EndPoint. If state transition fails it will fail the callback and leave the WriteFlusher in a terminal FAILED state. If not all buffers can be written in one go it creates a new PendingState object to preserve the state and then calls onIncompleteFlush(). The remaining buffers will be written in completeWrite(). If all buffers have been written it calls callback.complete().

Parameters

callback:Callback: the callback to call on either failed or complete
buffers:ByteBuffer[]: the buffers to flush to the endpoint

Exceptions

WritePendingException:: if unable to write due to prior pending write

write	back to summary
public void write(Callback callback, SocketAddress address, ByteBuffer... buffers) throws WritePendingException

org.eclipse.jetty.io back to summary

private Class WriteFlusher.CompletingState

Class Inheritance

extends State

java.lang.Object
org.eclipse.jetty.io.WriteFlusher.State
org.eclipse.jetty.io.WriteFlusher.CompletingState

In CompletingState WriteFlusher is flushing buffers that have not been fully written in write(). If write() didn't flush all buffers in one go, it'll switch the State to PendingState. completeWrite() will then switch to this state and try to flush the remaining buffers.

Constructor Summary

Access	Constructor and Description
private	CompletingState()

Method Summary

Inherited from org.eclipse.jetty.io.WriteFlusher.State:: getType toString

Constructor Detail

CompletingState	back to summary
private CompletingState()

org.eclipse.jetty.io back to summary

private Class WriteFlusher.FailedState

Class Inheritance

extends State

java.lang.Object
org.eclipse.jetty.io.WriteFlusher.State
org.eclipse.jetty.io.WriteFlusher.FailedState

In FailedState no more operations are allowed. The current implementation will never recover from this state.

Field Summary

Modifier and Type	Field and Description
private final Throwable	_cause

Constructor Summary

Access	Constructor and Description
private	FailedState(Throwable cause)

Method Summary

Modifier and Type	Method and Description
public Throwable	getCause()

Inherited from org.eclipse.jetty.io.WriteFlusher.State:: getType toString

Field Detail

_cause	back to summary
private final Throwable _cause

Constructor Detail

FailedState	back to summary
private FailedState(Throwable cause)

Method Detail

getCause	back to summary
public Throwable getCause()

org.eclipse.jetty.io back to summary

private Class WriteFlusher.IdleState

Class Inheritance

extends State

java.lang.Object
org.eclipse.jetty.io.WriteFlusher.State
org.eclipse.jetty.io.WriteFlusher.IdleState

In IdleState WriteFlusher is idle and accepts new writes

Constructor Summary

Access	Constructor and Description
private	IdleState()

Method Summary

Inherited from org.eclipse.jetty.io.WriteFlusher.State:: getType toString

Constructor Detail

IdleState	back to summary
private IdleState()

org.eclipse.jetty.io back to summary

public Interface WriteFlusher.Listener

A listener of WriteFlusher events. If implemented by a Connection class, the onFlushed(long) event will be delivered to it.

Method Summary

Modifier and Type	Method and Description
public void	onFlushed(long the number of bytes flushed bytes) Invoked when a `WriteFlusher` flushed bytes in a non-blocking way, as part of a - possibly larger - write.

Method Detail

onFlushed back to summary

onFlushed	back to summary
public void onFlushed(long bytes) throws IOException Invoked when a `WriteFlusher` flushed bytes in a non-blocking way, as part of a - possibly larger - write. This method may be invoked multiple times, for example when writing a large buffer: a first flush of bytes, then the connection became TCP congested, and a subsequent flush of bytes when the connection became writable again. This method is never invoked concurrently, but may be invoked by different threads, so implementations may not rely on thread-local variables. Implementations may throw an `IOException` to signal that the write should fail, for example if the implementation enforces a minimum data rate. Parameters bytes:long the number of bytes flushed Exceptions IOException: if the write should fail

public void onFlushed(long bytes) throws IOException

Invoked when a WriteFlusher flushed bytes in a non-blocking way, as part of a - possibly larger - write.

This method may be invoked multiple times, for example when writing a large buffer: a first flush of bytes, then the connection became TCP congested, and a subsequent flush of bytes when the connection became writable again.

This method is never invoked concurrently, but may be invoked by different threads, so implementations may not rely on thread-local variables.

Implementations may throw an IOException to signal that the write should fail, for example if the implementation enforces a minimum data rate.

Parameters

bytes:long: the number of bytes flushed

Exceptions

IOException:: if the write should fail

org.eclipse.jetty.io back to summary

private Class WriteFlusher.PendingState

Class Inheritance

extends State

java.lang.Object
org.eclipse.jetty.io.WriteFlusher.State
org.eclipse.jetty.io.WriteFlusher.PendingState

In PendingState not all buffers could be written in one go. Then write() will switch to PendingState() and preserve the state by creating a new PendingState object with the given parameters.

Field Summary

Modifier and Type	Field and Description
private final SocketAddress	_address
private final ByteBuffer[]	_buffers
private final Callback	_callback

Constructor Summary

Access	Constructor and Description
private	PendingState(Callback callback, SocketAddress address, ByteBuffer[] buffers)

Method Summary

Modifier and Type	Method and Description
pack-priv Invocable.InvocationType	getCallbackInvocationType()

Inherited from org.eclipse.jetty.io.WriteFlusher.State:: getType toString

Field Detail

_address	back to summary
private final SocketAddress _address

_buffers	back to summary
private final ByteBuffer[] _buffers

_callback	back to summary
private final Callback _callback

Constructor Detail

PendingState	back to summary
private PendingState(Callback callback, SocketAddress address, ByteBuffer[] buffers)

Method Detail

getCallbackInvocationType	back to summary
pack-priv Invocable.InvocationType getCallbackInvocationType()

org.eclipse.jetty.io back to summary

private Class WriteFlusher.State

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.io.WriteFlusher.State

Known Direct Subclasses

org.eclipse.jetty.io.WriteFlusher.IdleState, org.eclipse.jetty.io.WriteFlusher.WritingState, org.eclipse.jetty.io.WriteFlusher.FailedState, org.eclipse.jetty.io.WriteFlusher.CompletingState, org.eclipse.jetty.io.WriteFlusher.PendingState

State represents a State of WriteFlusher.

Field Summary

Modifier and Type	Field and Description
private final WriteFlusher.StateType	_type

Constructor Summary

Access	Constructor and Description
private	State(WriteFlusher.StateType stateType)

Method Summary

Modifier and Type	Method and Description
public WriteFlusher.StateType	getType()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

_type	back to summary
private final WriteFlusher.StateType _type

Constructor Detail

State	back to summary
private State(WriteFlusher.StateType stateType)

Method Detail

getType	back to summary
public WriteFlusher.StateType getType()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.eclipse.jetty.io back to summary

private final Enum WriteFlusher.StateType

Class Inheritance

extends Enum<WriteFlusher.StateType>

java.lang.Object
java.lang.Enum
org.eclipse.jetty.io.WriteFlusher.StateType

Field Summary

Modifier and Type	Field and Description
public static final WriteFlusher.StateType	COMPLETING
public static final WriteFlusher.StateType	FAILED
public static final WriteFlusher.StateType	IDLE
public static final WriteFlusher.StateType	PENDING
public static final WriteFlusher.StateType	WRITING

Constructor Summary

Access	Constructor and Description
private	StateType()

Method Summary

Modifier and Type	Method and Description
public static WriteFlusher.StateType	valueOf(String name)
public static WriteFlusher.StateType[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COMPLETING	back to summary
public static final WriteFlusher.StateType COMPLETING

FAILED	back to summary
public static final WriteFlusher.StateType FAILED

IDLE	back to summary
public static final WriteFlusher.StateType IDLE

PENDING	back to summary
public static final WriteFlusher.StateType PENDING

WRITING	back to summary
public static final WriteFlusher.StateType WRITING

Constructor Detail

StateType	back to summary
private StateType()

Method Detail

valueOf	back to summary
public static WriteFlusher.StateType valueOf(String name)

values	back to summary
public static WriteFlusher.StateType[] values()

public abstract Class WriteFlusher

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WriteFlusher.CompletingState

Constructor Summary

Method Summary

Constructor Detail

private Class WriteFlusher.FailedState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WriteFlusher.IdleState

Constructor Summary

Method Summary

Constructor Detail

public Interface WriteFlusher.Listener

Method Summary

Method Detail

private Class WriteFlusher.PendingState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WriteFlusher.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum WriteFlusher.StateType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WriteFlusher.WritingState

Constructor Summary

Method Summary

Constructor Detail