vibe.d beta banner
get vibe.d
0.8.1

Asynchronous I/O that doesn’t get in your way, written in D

Class TaskPipe

Implements a unidirectional data pipe between two tasks.

class TaskPipe
  : ConnectionStream ;

Constructors

NameDescription
thisConstructs a new pipe ready for use.

Properties

NameTypeDescription
bufferSize[get, set]ulongSize of the (fixed) FIFO buffer used to transfer data between tasks
connected[get]boolDetermines The current connection status.
dataAvailableForRead[get]bool(Scheduled for deprecation) Queries if there is data available for immediate, non-blocking read.
empty[get]boolReturns true iff the end of the input stream has been reached.
leastSize[get]ulong(Scheduled for deprecation) Returns the maximum number of bytes that are known to remain in this stream until the end is reached.

Methods

NameDescription
closeActively closes the connection and frees associated resources.
finalizeFlushes and finalizes the stream.
flushFlushes the stream and makes sure that all data is being written to the output device.
peekReturns a temporary reference to the data that is currently buffered.
readFills the preallocated array 'bytes' with data from the stream.
waitForDataBlocks until data becomes available for read.
writeWrites an array of bytes to the stream.
readFills the preallocated array 'bytes' with data from the stream.
writeWrites an array of bytes to the stream.
writePipes an InputStream directly into this OutputStream.

Aliases

NameDescription
read
write
Authors

Sönke Ludwig

Copyright

© 2013 RejectedSoftware e.K.

License

Subject to the terms of the MIT license, as written in the included LICENSE.txt file.