Modifier and Type	Class and Description
pack-priv class	AsyncContentProducer.LockedSemaphore A semaphore that assumes working under the same locked scope.

Modifier and Type	Field and Description
private long	_bytesArrived
private Content.Chunk	_chunk
private long	_firstByteNanoTime
pack-priv final AutoLock	_lock
private final ServletChannel	_servletChannel
private static final Logger	LOG
private static final Content.Chunk	RECYCLED_ERROR_CHUNK

Access	Constructor and Description
pack-priv	AsyncContentProducer(ServletChannel The ServletChannel to produce input from. servletChannel, AutoLock The lock of the HttpInput, shared with this instance lock)

Method Summary

Modifier and Type	Method and Description
private void	assertLocked()
public int	available() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.available. Get the byte count that can immediately be read from this `ContentProducer` instance or the underlying `Content.Source`.
public void	checkMinDataRate() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.checkMinDataRate. Check if the current data rate consumption is above the minimal rate.
public boolean	consumeAvailable() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.consumeAvailable. Fail all content currently available in this `ContentProducer` instance as well as in the underlying `Content.Source`.
private boolean	consumeAvailableChunks()
private boolean	consumeCurrentChunk()
public long	getBytesArrived() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.getBytesArrived. Get the byte count produced by the underlying `Content.Source`.
pack-priv ServletChannel	getServletChannel()
public boolean	hasChunk() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.hasChunk. Check if this `ContentProducer` instance contains some content chunk without querying the underlying `Content.Source`.
public boolean	isError() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.isError. Check if the underlying `Content.Source` reached an error content.
public boolean	isReady() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.isReady. Check if this `ContentProducer` instance has some content that can be read without blocking.
pack-priv boolean	isUnready()
pack-priv AsyncContentProducer.LockedSemaphore	newLockedSemaphore()
public Content.Chunk	nextChunk() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.nextChunk. Get the next content chunk that can be read from or that describes the terminal condition that was reached (error, eof).
public boolean	onContentProducible() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.onContentProducible. Wake up the thread that is waiting for the next content.
private Content.Chunk	produceChunk()
private Content.Chunk	readChunk()
public void	reclaim(Content.Chunk chunk) Implements org.eclipse.jetty.ee10.servlet.ContentProducer.reclaim. Free up the content by calling `Content.Chunk#release()` on it and updating this instance's internal state.
public void	recycle() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.recycle. A recycled `ContentProducer` will only produce special content with a non-null error until `reopen()` is called.
public void	reopen() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.reopen. Reset all internal state, making this is instance logically equivalent to a freshly allocated one.
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

_bytesArrived	back to summary
private long _bytesArrived

_chunk	back to summary
private Content.Chunk _chunk

_firstByteNanoTime	back to summary
private long _firstByteNanoTime

_lock	back to summary
pack-priv final AutoLock _lock

_servletChannel	back to summary
private final ServletChannel _servletChannel

LOG	back to summary
private static final Logger LOG

RECYCLED_ERROR_CHUNK	back to summary
private static final Content.Chunk RECYCLED_ERROR_CHUNK

Constructor Detail

AsyncContentProducer	back to summary
pack-priv AsyncContentProducer(ServletChannel servletChannel, AutoLock lock) Parameters servletChannel:ServletChannel The ServletChannel to produce input from. lock:AutoLock The lock of the HttpInput, shared with this instance

Method Detail

assertLocked	back to summary
private void assertLocked()

available back to summary

available	back to summary
public int available() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.available. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.available. Get the byte count that can immediately be read from this `ContentProducer` instance or the underlying `Content.Source`. This call is always non-blocking. Doesn't change state. Returns:int the available byte count. Annotations @Override

public int available()

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.available.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.available.

Get the byte count that can immediately be read from this ContentProducer instance or the underlying Content.Source. This call is always non-blocking. Doesn't change state.

Returns:int

the available byte count.

Annotations

@Override

checkMinDataRate	back to summary
public void checkMinDataRate() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.checkMinDataRate. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.checkMinDataRate. Check if the current data rate consumption is above the minimal rate. Abort the channel, fail the content currently available and throw a BadMessageException(REQUEST_TIMEOUT_408) if the check fails. Annotations @Override

checkMinDataRate

back to summary

public void checkMinDataRate()

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.checkMinDataRate.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.checkMinDataRate.

Check if the current data rate consumption is above the minimal rate. Abort the channel, fail the content currently available and throw a BadMessageException(REQUEST_TIMEOUT_408) if the check fails.

Annotations

@Override

consumeAvailable back to summary

consumeAvailable	back to summary
public boolean consumeAvailable() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.consumeAvailable. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.consumeAvailable. Fail all content currently available in this `ContentProducer` instance as well as in the underlying `Content.Source`. This call is always non-blocking. Doesn't change state. Returns:boolean true if EOF was reached. Annotations @Override

public boolean consumeAvailable()

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.consumeAvailable.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.consumeAvailable.

Fail all content currently available in this ContentProducer instance as well as in the underlying Content.Source. This call is always non-blocking. Doesn't change state.

Returns:boolean

true if EOF was reached.

Annotations

@Override

consumeAvailableChunks	back to summary
private boolean consumeAvailableChunks()

consumeCurrentChunk	back to summary
private boolean consumeCurrentChunk()

getBytesArrived back to summary

getBytesArrived	back to summary
public long getBytesArrived() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.getBytesArrived. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.getBytesArrived. Get the byte count produced by the underlying `Content.Source`. This call is always non-blocking. Doesn't change state. Returns:long the byte count produced by the underlying `Content.Source`. Annotations @Override

public long getBytesArrived()

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.getBytesArrived.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.getBytesArrived.

Get the byte count produced by the underlying Content.Source. This call is always non-blocking. Doesn't change state.

Returns:long

the byte count produced by the underlying Content.Source.

Annotations

@Override

getServletChannel	back to summary
pack-priv ServletChannel getServletChannel()

hasChunk back to summary

hasChunk	back to summary
public boolean hasChunk() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.hasChunk. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.hasChunk. Check if this `ContentProducer` instance contains some content chunk without querying the underlying `Content.Source`. This call is always non-blocking. Doesn't change state. Doesn't query the HttpChannel. Returns:boolean true if this `ContentProducer` instance contains content, false otherwise. Annotations @Override

public boolean hasChunk()

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.hasChunk.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.hasChunk.

Check if this ContentProducer instance contains some content chunk without querying the underlying Content.Source. This call is always non-blocking. Doesn't change state. Doesn't query the HttpChannel.

Returns:boolean

true if this ContentProducer instance contains content, false otherwise.

Annotations

@Override

isError back to summary

isError	back to summary
public boolean isError() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.isError. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.isError. Check if the underlying `Content.Source` reached an error content. This call is always non-blocking. Doesn't change state. Doesn't query the HttpChannel. Returns:boolean true if the underlying `Content.Source` reached an error content, false otherwise. Annotations @Override

public boolean isError()

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.isError.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.isError.

Check if the underlying Content.Source reached an error content. This call is always non-blocking. Doesn't change state. Doesn't query the HttpChannel.

Returns:boolean

true if the underlying Content.Source reached an error content, false otherwise.

Annotations

@Override

isReady back to summary

isReady	back to summary
public boolean isReady() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.isReady. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.isReady. Check if this `ContentProducer` instance has some content that can be read without blocking. If there is some, the next call to `nextChunk()` will not block. If there isn't any and the implementation does not block, this method will trigger a `jakarta.servlet.ReadListener` callback once some content is available. This call is always non-blocking. Returns:boolean true if some content is immediately available, false otherwise. Annotations @Override

public boolean isReady()

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.isReady.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.isReady.

Check if this ContentProducer instance has some content that can be read without blocking. If there is some, the next call to nextChunk() will not block. If there isn't any and the implementation does not block, this method will trigger a jakarta.servlet.ReadListener callback once some content is available. This call is always non-blocking.

Returns:boolean

true if some content is immediately available, false otherwise.

Annotations

@Override

isUnready	back to summary
pack-priv boolean isUnready()

newLockedSemaphore	back to summary
pack-priv AsyncContentProducer.LockedSemaphore newLockedSemaphore()

nextChunk	back to summary
public Content.Chunk nextChunk() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.nextChunk. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.nextChunk. Get the next content chunk that can be read from or that describes the terminal condition that was reached (error, eof). This call may or may not block until some content is available, depending on the implementation. After this call, state can be either of UNREADY or IDLE. Returns:Content.Chunk the next content chunk that can be read from or null if the implementation does not block and has no available content. Annotations @Override

nextChunk

back to summary

public Content.Chunk nextChunk()

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.nextChunk.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.nextChunk.

Get the next content chunk that can be read from or that describes the terminal condition that was reached (error, eof). This call may or may not block until some content is available, depending on the implementation. After this call, state can be either of UNREADY or IDLE.

Returns:Content.Chunk

the next content chunk that can be read from or null if the implementation does not block and has no available content.

Annotations

@Override

onContentProducible	back to summary
public boolean onContentProducible() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.onContentProducible. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.onContentProducible. Wake up the thread that is waiting for the next content. After this call, state can be READY. Returns:boolean true if the thread has to be rescheduled, false otherwise. Annotations @Override

onContentProducible

back to summary

public boolean onContentProducible()

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.onContentProducible.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.onContentProducible.

Wake up the thread that is waiting for the next content. After this call, state can be READY.

Returns:boolean

true if the thread has to be rescheduled, false otherwise.

Annotations

@Override

produceChunk	back to summary
private Content.Chunk produceChunk()

readChunk	back to summary
private Content.Chunk readChunk()

reclaim back to summary

reclaim	back to summary
public void reclaim(Content.Chunk chunk) Implements org.eclipse.jetty.ee10.servlet.ContentProducer.reclaim. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.reclaim. Free up the content by calling `Content.Chunk#release()` on it and updating this instance's internal state. Annotations @Override

public void reclaim(Content.Chunk chunk)

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.reclaim.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.reclaim.

Free up the content by calling Content.Chunk#release() on it and updating this instance's internal state.

Annotations

@Override

recycle back to summary

recycle	back to summary
public void recycle() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.recycle. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.recycle. A recycled `ContentProducer` will only produce special content with a non-null error until `reopen()` is called. Annotations @Override

public void recycle()

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.recycle.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.recycle.

A recycled ContentProducer will only produce special content with a non-null error until reopen() is called.

Annotations

@Override

reopen	back to summary
public void reopen() Implements org.eclipse.jetty.ee10.servlet.ContentProducer.reopen. Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.reopen. Reset all internal state, making this is instance logically equivalent to a freshly allocated one. Annotations @Override

reopen

back to summary

public void reopen()

Implements org.eclipse.jetty.ee10.servlet.ContentProducer.reopen.

Doc from org.eclipse.jetty.ee10.servlet.ContentProducer.reopen.

Reset all internal state, making this is instance logically equivalent to a freshly allocated one.

Annotations

@Override

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

org.eclipse.jetty.ee10.servlet back to summary

pack-priv Class AsyncContentProducer.LockedSemaphore

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.ee10.servlet.AsyncContentProducer.LockedSemaphore

A semaphore that assumes working under the same locked scope.

Field Summary

Modifier and Type	Field and Description
private final Condition	_condition
private int	_permits

Constructor Summary

Access	Constructor and Description
private	LockedSemaphore()

Method Summary

Modifier and Type	Method and Description
pack-priv void	acquire()
pack-priv void	assertLocked()
pack-priv void	drainPermits()
pack-priv void	release()
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

_condition	back to summary
private final Condition _condition

_permits	back to summary
private int _permits

Constructor Detail

LockedSemaphore	back to summary
private LockedSemaphore()

Method Detail

acquire	back to summary
pack-priv void acquire() throws InterruptedException

assertLocked	back to summary
pack-priv void assertLocked()

drainPermits	back to summary
pack-priv void drainPermits()

release	back to summary
pack-priv void release()

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

pack-priv Class AsyncContentProducer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class AsyncContentProducer.LockedSemaphore

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail