vibe.d beta banner
get vibe.d
0.8.4

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
this Constructs 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 available for read.

Methods

NameDescription
close Actively closes the connection and frees associated resources.
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.
read Fills the preallocated array 'bytes' with data from the stream.
waitForData Blocks until data becomes available for read.
write Writes an array of bytes to the stream.
read Fills the preallocated array 'bytes' with data from the stream.
write Writes an array of bytes to the stream.

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.