Interface StreamingResponseContext

@ThreadSafe
public interface StreamingResponseContext

Runtime context for a streaming response producer.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
default @NonNull Optional<Throwable>	getCancelationCause()	The underlying cancelation cause, if available.
default @NonNull Optional<StreamTerminationReason>	getCancelationReason()	The cancelation reason, if canceled.
@NonNull CancelationToken	getCancelationToken()	The cancelation token for this streaming response.
@NonNull Optional<Instant>	getDeadline()	The absolute deadline for this stream, if one is configured.
@NonNull Optional<Duration>	getIdleTimeout()	The idle timeout for this stream, if one is configured.
@NonNull Request	getRequest()	The request that produced this streaming response.
default @NonNull Boolean	isCanceled()	Is the streaming response canceled?
default @NonNull AutoCloseable	onCancel(@NonNull Runnable callback)	Registers a callback that runs when the stream is canceled.
default void	throwIfCanceled()	Throws if the stream has been canceled.

Method Details

getCancelationToken

@NonNull CancelationToken getCancelationToken()

The cancelation token for this streaming response.

Returns:

the cancelation token

getRequest

@NonNull Request getRequest()

The request that produced this streaming response.

Returns:

the request that produced this streaming response

getDeadline

@NonNull Optional<Instant> getDeadline()

The absolute deadline for this stream, if one is configured.

Returns:

the streaming deadline, or Optional.empty() if no deadline is configured

getIdleTimeout

@NonNull Optional<Duration> getIdleTimeout()

The idle timeout for this stream, if one is configured.

Returns:

the streaming idle timeout, or Optional.empty() if disabled

isCanceled

default @NonNull Boolean isCanceled()

Is the streaming response canceled?

Returns:

true if canceled

getCancelationReason

default @NonNull Optional<StreamTerminationReason> getCancelationReason()

The cancelation reason, if canceled.

Returns:

the cancelation reason, or Optional.empty() if not canceled

getCancelationCause

default @NonNull Optional<Throwable> getCancelationCause()

The underlying cancelation cause, if available.

Returns:

the underlying cause, or Optional.empty() if none is available

onCancel

default @NonNull AutoCloseable onCancel(@NonNull Runnable callback)

Registers a callback that runs when the stream is canceled.

Parameters:

callback - the callback to run on cancelation

Returns:

a handle that removes the callback when closed

throwIfCanceled

default void throwIfCanceled()
                      throws StreamingResponseCanceledException

Throws if the stream has been canceled.

Throws:

StreamingResponseCanceledException - if canceled