Package vn.payos.core

Interface AsyncStreamResponse<T>

All Known Implementing Classes:

AsyncAutoPager

public interface AsyncStreamResponse<T>

AsyncStreamResponse

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AsyncStreamResponse.Handler<T>	Handler interface for processing streaming responses.
static enum	AsyncStreamResponse.State	Stream state enumeration

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this resource, relinquishing any underlying resources.
CompletableFuture<Void>	onCompleteFuture()	Returns a future that completes when a stream is fully consumed, errors, or gets closed early.
AsyncStreamResponse<T>	subscribe(AsyncStreamResponse.Handler<T> handler)	Registers handler to be called for events of this stream.
AsyncStreamResponse<T>	subscribe(AsyncStreamResponse.Handler<T> handler, Executor executor)	Registers handler to be called for events of this stream.

Method Details

subscribe

AsyncStreamResponse<T> subscribe(AsyncStreamResponse.Handler<T> handler)

Registers handler to be called for events of this stream.

Handler's methods will be called in the client's configured or default thread pool.

Parameters:

handler - Handler to process items and completion events

Returns:

this AsyncStreamResponse for chaining

Throws:

IllegalStateException - if subscribe has already been called

subscribe

AsyncStreamResponse<T> subscribe(AsyncStreamResponse.Handler<T> handler,
 Executor executor)

Registers handler to be called for events of this stream.

Handler's methods will be called in the given executor.

Parameters:

handler - Handler to process items and completion events

executor - Executor to run handler methods in

Returns:

this AsyncStreamResponse for chaining

Throws:

IllegalStateException - if subscribe has already been called

onCompleteFuture

CompletableFuture<Void> onCompleteFuture()

Returns a future that completes when a stream is fully consumed, errors, or gets closed early.

Returns:

CompletableFuture for completion tracking

close

void close()

Closes this resource, relinquishing any underlying resources.

This is purposefully not inherited from AutoCloseable because this response should not be synchronously closed via try-with-resources.