Package org.jenkinsci.remoting.util

Class ByteBufferQueueInputStream

java.lang.Object

java.io.InputStream

org.jenkinsci.remoting.util.ByteBufferQueueInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ByteBufferQueueInputStream
extends InputStream

An InputStream backed by a ByteBufferQueue. Assumes that the backing ByteBufferQueue will not be updated by another thread during calls to read() so all methods are non-blocking and an empty ByteBufferQueue is deemed equivalent to end of stream.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
ByteBufferQueueInputStream(ByteBufferQueue queue)	Constructs a new instance.
ByteBufferQueueInputStream(ByteBufferQueue queue, int length)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
int	available()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.io.InputStream

close, nullInputStream, read, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ByteBufferQueueInputStream

public ByteBufferQueueInputStream(ByteBufferQueue queue)

Constructs a new instance.

Parameters:

queue - the backing ByteBufferQueue.

ByteBufferQueueInputStream

public ByteBufferQueueInputStream(ByteBufferQueue queue,
 int length)

Constructs a new instance.

Parameters:

queue - the backing ByteBufferQueue.

length - the limit of bytes to take from the backing queue.

Method Details

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream