Class StreamLimitException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.io.IOException

java.net.http.StreamLimitException

All Implemented Interfaces:

Serializable

public final class StreamLimitException
extends IOException

An exception raised when the limit imposed for stream creation on an HTTP connection is reached, and the client is unable to create a new stream.

A StreamLimitException may be raised when attempting to send a new request on any protocol version that supports multiplexing on a single connection. Both HTTP/2 and HTTP/3 allow multiplexing concurrent requests to the same server on a single connection. Each request/response exchange is carried over a single stream, as defined by the corresponding protocol.

Whether and when a StreamLimitException may be relayed to the code initiating a request/response exchange is implementation and protocol version dependent.

Since:

26

See Also:

• HttpClient.send(HttpRequest, BodyHandler)
• HttpClient.sendAsync(HttpRequest, BodyHandler)
• HttpClient.sendAsync(HttpRequest, BodyHandler, PushPromiseHandler)
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StreamLimitException(HttpClient.Version version, String message)	Creates a new StreamLimitException

Method Summary

Modifier and Type	Method	Description
final HttpClient.Version	version()	Returns the protocol version for which the exception was raised.

Methods declared in class Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Modifier and Type	Method	Description
final void	addSuppressed(Throwable exception)	Appends the specified exception to the exceptions that were suppressed in order to deliver this exception.
Throwable	fillInStackTrace()	Fills in the execution stack trace.
Throwable	getCause()	Returns the cause of this throwable or null if the cause is nonexistent or unknown.
String	getLocalizedMessage()	Creates a localized description of this throwable.
String	getMessage()	Returns the detail message string of this throwable.
StackTraceElement[]	getStackTrace()	Provides programmatic access to the stack trace information printed by Throwable.printStackTrace().
final Throwable[]	getSuppressed()	Returns an array containing all of the exceptions that were suppressed, typically by the try-with-resources statement, in order to deliver this exception.
Throwable	initCause(Throwable cause)	Initializes the cause of this throwable to the specified value.
void	printStackTrace()	Prints this throwable and its backtrace to the standard error stream.
void	printStackTrace(PrintStream s)	Prints this throwable and its backtrace to the specified print stream.
void	printStackTrace(PrintWriter s)	Prints this throwable and its backtrace to the specified print writer.
void	setStackTrace(StackTraceElement[] stackTrace)	Sets the stack trace elements that will be returned by Throwable.getStackTrace() and printed by Throwable.printStackTrace() and related methods.
String	toString()	Returns a short description of this throwable.

Methods declared in class Object

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

Modifier and Type	Method	Description
protected Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
int	hashCode()	Returns a hash code value for this object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

StreamLimitException

public StreamLimitException(HttpClient.Version version,
 String message)

Creates a new StreamLimitException

Parameters:

version - the version of the protocol on which the stream limit exception occurred. Must not be null.

message - the detailed exception message, which can be null.

Method Details

version

public final HttpClient.Version version()

Returns the protocol version for which the exception was raised.

Returns:

the protocol version for which the exception was raised