public class PacketLineOut extends Object
This class is not thread safe and may issue multiple writes to the underlying stream for each method call made.
This class performs no buffering on its own. This makes it suitable to interleave writes performed by this class with writes performed directly against the underlying OutputStream.
Constructor and Description |
---|
PacketLineOut(OutputStream outputStream)
Create a new packet line writer.
|
Modifier and Type | Method and Description |
---|---|
void |
end()
Write a packet end marker, sometimes referred to as a flush command.
|
void |
flush()
Flush the underlying OutputStream.
|
void |
setFlushOnEnd(boolean flushOnEnd)
Set the flush behavior during
end() . |
void |
writePacket(byte[] packet)
Write a binary packet to the stream.
|
void |
writeString(String s)
Write a UTF-8 encoded string as a single length-delimited packet.
|
public PacketLineOut(OutputStream outputStream)
outputStream
- stream.public void setFlushOnEnd(boolean flushOnEnd)
end()
.flushOnEnd
- if true, a flush-pkt written during end()
also
flushes the underlying stream.public void writeString(String s) throws IOException
s
- string to write.IOException
- the packet could not be written, the stream is corrupted as
the packet may have been only partially written.public void writePacket(byte[] packet) throws IOException
packet
- the packet to write; the length of the packet is equal to the
size of the byte array.IOException
- the packet could not be written, the stream is corrupted as
the packet may have been only partially written.public void end() throws IOException
Technically this is a magical packet type which can be detected separately from an empty string or an empty packet.
Implicitly performs a flush on the underlying OutputStream to ensure the peer will receive all data written thus far.
IOException
- the end marker could not be written, the stream is corrupted
as the end marker may have been only partially written.public void flush() throws IOException
Performs a flush on the underlying OutputStream to ensure the peer will receive all data written thus far.
IOException
- the underlying stream failed to flush.Copyright © 2015 Eclipse JGit Project. All rights reserved.