Top Description Fields Constructors Methods
org.eclipse.jgit.transport

public Class SideBandInputStream

extends InputStream
Class Inheritance
Static Imports
java.nio.charset.StandardCharsets.UTF_8, org.eclipse.jgit.transport.SideBandOutputStream.HDR_SIZE
Unmultiplexes the data portion of a side-band channel.

Reading from this input stream obtains data from channel 1, which is typically the bulk data stream.

Channel 2 is transparently unpacked and "scraped" to update a progress monitor. The scraping is performed behind the scenes as part of any of the read methods offered by this stream.

Channel 3 results in an exception being thrown, as the remote side has issued an unrecoverable error.

Since
4.11
See Also
SideBandOutputStream

Field Summary

Modifier and TypeField and Description
private int
available

pack-priv static final int
CH_DATA

pack-priv static final int
CH_ERROR

pack-priv static final int
CH_PROGRESS

private int
channel

private String
currentTask

private boolean
eof

private int
lastCnt

private static final Logger
LOG

private final Writer
messages

private final ProgressMonitor
monitor

private final OutputStream
out

private static Pattern
P_BOUNDED

private static Pattern
P_UNBOUNDED

private final PacketLineIn
pckIn

private String
progressBuffer

private final InputStream
rawIn

Constructor Summary

AccessConstructor and Description
pack-priv
SideBandInputStream(final InputStream in, final ProgressMonitor progress, final Writer messageStream, OutputStream outputStream)

Method Summary

Modifier and TypeMethod and Description
private void
beginTask(int totalWorkUnits)

private void
doProgressLine(String msg)

pack-priv void
drainMessages()

Forces any buffered progress messages to be written.

private void
needDataPacket()

private void
progress(String pkt)

public int
read()

Implements abstract java.io.InputStream.read.

Reads the next byte of data from the input stream.

public int
read(byte[]
the buffer into which the data is read.
b, int
the start offset in array b at which the data is written.
off, int
the maximum number of bytes to read.
len)

Overrides java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes.

private String
readString(int len)

private static String
remote(String msg)

Inherited from java.io.InputStream:
availableclosemarkmarkSupportednullInputStreamreadreadAllBytesreadNBytesreadNBytesresetskipskipNBytestransferTo

Field Detail

availableback to summary
private int available
CH_DATAback to summary
pack-priv static final int CH_DATA
CH_ERRORback to summary
pack-priv static final int CH_ERROR
CH_PROGRESSback to summary
pack-priv static final int CH_PROGRESS
channelback to summary
private int channel
currentTaskback to summary
private String currentTask
eofback to summary
private boolean eof
lastCntback to summary
private int lastCnt
LOGback to summary
private static final Logger LOG
messagesback to summary
private final Writer messages
monitorback to summary
private final ProgressMonitor monitor
outback to summary
private final OutputStream out
P_BOUNDEDback to summary
private static Pattern P_BOUNDED
P_UNBOUNDEDback to summary
private static Pattern P_UNBOUNDED
pckInback to summary
private final PacketLineIn pckIn
progressBufferback to summary
private String progressBuffer
rawInback to summary
private final InputStream rawIn

Constructor Detail

SideBandInputStreamback to summary
pack-priv SideBandInputStream(final InputStream in, final ProgressMonitor progress, final Writer messageStream, OutputStream outputStream)

Method Detail

beginTaskback to summary
private void beginTask(int totalWorkUnits)
doProgressLineback to summary
private void doProgressLine(String msg) throws IOException
drainMessagesback to summary
pack-priv void drainMessages()

Forces any buffered progress messages to be written.

needDataPacketback to summary
private void needDataPacket() throws IOException
progressback to summary
private void progress(String pkt) throws IOException
readback to summary
public int read() throws IOException

Implements abstract java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:int

the next byte of data, or -1 if the end of the stream is reached.

Annotations
@Override
Exceptions
IOException:
if an I/O error occurs.
readback to summary
public int read(byte[] b, int off, int len) throws IOException

Overrides java.io.InputStream.read.

Doc from java.io.InputStream.read.

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b.

The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected.

In every case, elements b[0] through b[off-1] and elements b[off+len] through b[b.length-1] are unaffected.

Parameters
b:byte[]

the buffer into which the data is read.

off:int

the start offset in array b at which the data is written.

len:int

the maximum number of bytes to read.

Returns:int

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Annotations
@Override
Exceptions
IOException:
If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.
readStringback to summary
private String readString(int len) throws IOException
remoteback to summary
private static String remote(String msg)