Pipe.read

Read a specified message from the pipe. Moves the internal offset so that every call to read will return a new portion of the message.

  1. size_t read(ubyte* output, size_t length)
  2. size_t read(ubyte* output, size_t length, message_id msg)
    struct Pipe
    public
    size_t
    read
    (
    ubyte* output
    ,
    size_t length
    ,)
  3. size_t read(ubyte[] output, message_id msg)
  4. size_t read(ubyte output, message_id msg)

Parameters

output ubyte*

the ubyte array to write the read bytes to

length size_t

the length of the ubyte array output

msg message_id

the number identifying the message to read from

Return Value

Type: size_t

number of bytes actually read into output

Meta