Module: xenomai-head Branch: master Commit: 802c173abedb0b82010fb80da1ec6abf1fa765ad URL: http://git.xenomai.org/?p=xenomai-head.git;a=commit;h=802c173abedb0b82010fb80da1ec6abf1fa765ad
Author: Philippe Gerum <r...@xenomai.org> Date: Mon Feb 21 21:06:58 2011 +0100 nucleus/pipe: fix RT_PIPE documentation --- ksrc/skins/native/pipe.c | 24 +++++++++++++++--------- 1 files changed, 15 insertions(+), 9 deletions(-) diff --git a/ksrc/skins/native/pipe.c b/ksrc/skins/native/pipe.c index d756758..1690518 100644 --- a/ksrc/skins/native/pipe.c +++ b/ksrc/skins/native/pipe.c @@ -699,9 +699,6 @@ ssize_t rt_pipe_read(RT_PIPE *pipe, void *buf, size_t size, RTIME timeout) * * - -EINVAL is returned if @a pipe is not a pipe descriptor. * - * - -EPIPE is returned if the associated special device is not yet - * open. - * * - -EIDRM is returned if @a pipe is a closed pipe descriptor. * * - -ENODEV or -EBADF are returned if @a pipe is scrambled. @@ -715,6 +712,11 @@ ssize_t rt_pipe_read(RT_PIPE *pipe, void *buf, size_t size, RTIME timeout) * - Kernel-based task * * Rescheduling: possible. + * + * @note Writing data to a pipe before any peer has opened the + * associated special device is allowed. The output will be buffered + * until then, only restricted by the available memory in the relevant + * buffer pool (see rt_pipe_create()). */ ssize_t rt_pipe_send(RT_PIPE *pipe, RT_PIPE_MSG *msg, size_t size, int mode) @@ -780,9 +782,6 @@ ssize_t rt_pipe_send(RT_PIPE *pipe, RT_PIPE_MSG *msg, size_t size, int mode) * * - -EINVAL is returned if @a pipe is not a pipe descriptor. * - * - -EPIPE is returned if the associated special device is not yet - * open. - * * - -ENOMEM is returned if not enough buffer space is available to * complete the operation. * @@ -800,6 +799,11 @@ ssize_t rt_pipe_send(RT_PIPE *pipe, RT_PIPE_MSG *msg, size_t size, int mode) * - User-space task * * Rescheduling: possible. + * + * @note Writing data to a pipe before any peer has opened the + * associated special device is allowed. The output will be buffered + * until then, only restricted by the available memory in the relevant + * buffer pool (see rt_pipe_create()). */ ssize_t rt_pipe_write(RT_PIPE *pipe, const void *buf, size_t size, int mode) @@ -856,9 +860,6 @@ ssize_t rt_pipe_write(RT_PIPE *pipe, const void *buf, size_t size, int mode) * * - -EINVAL is returned if @a pipe is not a pipe descriptor. * - * - -EPIPE is returned if the associated special device is not yet - * open. - * * - -EIDRM is returned if @a pipe is a closed pipe descriptor. * * - -ENODEV or -EBADF are returned if @a pipe is scrambled. @@ -877,6 +878,11 @@ ssize_t rt_pipe_write(RT_PIPE *pipe, const void *buf, size_t size, int mode) * - User-space task * * Rescheduling: possible. + * + * @note Writing data to a pipe before any peer has opened the + * associated special device is allowed. The output will be buffered + * until then, only restricted by the available memory in the relevant + * buffer pool (see rt_pipe_create()). */ ssize_t rt_pipe_stream(RT_PIPE *pipe, const void *buf, size_t size) _______________________________________________ Xenomai-git mailing list Xenomai-git@gna.org https://mail.gna.org/listinfo/xenomai-git
