Class AbortableInputStreamSubscriber

java.lang.Object

java.io.InputStream

software.amazon.awssdk.http.async.AbortableInputStreamSubscriber

All Implemented Interfaces:

Closeable, AutoCloseable, org.reactivestreams.Subscriber<ByteBuffer>, Abortable

public final class AbortableInputStreamSubscriber
extends InputStream
implements org.reactivestreams.Subscriber<ByteBuffer>, Abortable

Wrapper of InputStreamSubscriber that also implements Abortable. It will invoke close() when abort() is invoked. Upon closing, the underlying InputStreamSubscriber will be closed, and additional action can be added via AbortableInputStreamSubscriber.Builder.doAfterClose(Runnable).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AbortableInputStreamSubscriber.Builder

Method Summary

Modifier and Type	Method	Description
void	abort()	Aborts the execution of the task.
static AbortableInputStreamSubscriber.Builder	builder()
void	close()
void	onComplete()
void	onError(Throwable t)
void	onNext(ByteBuffer byteBuffer)
void	onSubscribe(org.reactivestreams.Subscription s)
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)

Methods inherited from class java.io.InputStream

available, mark, markSupported, reset, skip

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static AbortableInputStreamSubscriber.Builder builder()

abort

public void abort()

Description copied from interface: Abortable

Aborts the execution of the task. Multiple calls to abort or calling abort an already aborted task should return without error.

Specified by:

abort in interface Abortable

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
 int off,
 int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

onSubscribe

public void onSubscribe(org.reactivestreams.Subscription s)

Specified by:

onSubscribe in interface org.reactivestreams.Subscriber<ByteBuffer>

onNext

public void onNext(ByteBuffer byteBuffer)

Specified by:

onNext in interface org.reactivestreams.Subscriber<ByteBuffer>

onError

public void onError(Throwable t)

Specified by:

onError in interface org.reactivestreams.Subscriber<ByteBuffer>

onComplete

public void onComplete()

Specified by:

onComplete in interface org.reactivestreams.Subscriber<ByteBuffer>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream