Interface ConnectionStream
Interface for streams based on a connection.
Connection streams are based on streaming socket connections, pipes and similar end-to-end streams.
Inherits from
Properties
Name | Type | Description |
---|---|---|
connected
[get]
|
bool |
Determines The current connection status. |
dataAvailableForRead
[get]
|
bool |
Queries if there is data available for immediate, non-blocking read .
|
empty
[get]
|
bool |
Returns true iff the end of the input stream has been reached. |
leastSize
[get]
|
ulong |
Returns the maximum number of bytes that are known to remain in this stream until the
end is reached. After leastSize () bytes have been read , the stream will either have
reached EOS and empty () returns true, or leastSize () returns again a number > 0.
|
Methods
Name | Description |
---|---|
close
|
Actively closes the connection and frees associated resources. |
waitForData
|
Sets a timeout until data has to be availabe for read . Returns false on timeout .
|
finalize
|
Flushes and finalizes the stream. |
flush
|
Flushes the stream and makes sure that all data is being written to the output device. |
peek
|
Returns a temporary reference to the data that is currently buffered, typically has the size
leastSize () or 0 if dataAvailableForRead () returns false.
|
put
|
These methods provide an output range interface. |
read
|
Fills the preallocated array 'bytes' with data from the stream. |
write
|
Writes an array of bytes to the stream.
|
write
|
Writes an array of chars to the stream. |
write
|
Pipes an InputStream directly into this OutputStream .
|
See also
vibe.core.new.TCPConnection
Authors
Sönke Ludwig
Copyright
© 2012-2013 RejectedSoftware e.K.
License
Subject to the terms of the MIT license, as written in the included LICENSE.txt file.