zephyr::raw

Function k_pipe_put

source
pub unsafe extern "C" fn k_pipe_put(
    pipe: *mut k_pipe,
    data: *const c_void,
    bytes_to_write: usize,
    bytes_written: *mut usize,
    min_xfer: usize,
    timeout: k_timeout_t,
) -> i32
Expand description

@brief Write data to a pipe.

This routine writes up to @a bytes_to_write bytes of data to @a pipe.

@param pipe Address of the pipe. @param data Address of data to write. @param bytes_to_write Size of data (in bytes). @param bytes_written Address of area to hold the number of bytes written. @param min_xfer Minimum number of bytes to write. @param timeout Waiting period to wait for the data to be written, or one of the special values K_NO_WAIT and K_FOREVER.

@retval 0 At least @a min_xfer bytes of data were written. @retval -EIO Returned without waiting; zero data bytes were written. @retval -EAGAIN Waiting period timed out; between zero and @a min_xfer minus one data bytes were written.