NAME

       muroar_read - Read data from a stream in a portable way

SYNOPSIS

       #include <muroar.h>

       ssize_t muroar_read   (muroar_t fh,  void * buf, size_t len);

DESCRIPTION

       This  function  reads data from a stream connected to a sound server.  It exists to have a
       portable way to read data from the sound server that does not  depend  on  the  underlying
       operating system.

PARAMETERS

       fh     The  stream  file  handle  connected  to  the  server.   This  must  be opend using
              muroar_stream(3).

       buf    A pointer to the block of data that should be read.

       len    The total length in byte of the data that should be read.

RETURN VALUE

       On success this call return the  number  of  bytes  successful  read.   On  error,  -1  is
       returned.

NOTES

       This function calls the underlying read function in a loop.  If this returns less than the
       given length you should not re-try directly but wait at least some milisecunds.

HISTORY

       This function first appeared in muRoar version 0.1beta0.

SEE ALSO

       read(2), muroar_write(3), muroar_stream(3), muroar_close(3), RoarAudio(7).