From 4cac86448608e30625b8a68338f2885e17acd5c7 Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Wed, 20 Jul 2016 15:19:13 +0200 Subject: Add libcoopgamma_*_marshal.3 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- doc/man/libcoopgamma_context_marshal.3 | 52 ++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 doc/man/libcoopgamma_context_marshal.3 (limited to 'doc/man/libcoopgamma_context_marshal.3') diff --git a/doc/man/libcoopgamma_context_marshal.3 b/doc/man/libcoopgamma_context_marshal.3 new file mode 100644 index 0000000..e3341bb --- /dev/null +++ b/doc/man/libcoopgamma_context_marshal.3 @@ -0,0 +1,52 @@ +.TH LIBCOOPGAMMA_CONTEXT_MARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_context_marshal - Marshal a libcoopgamma_context_t +.SH "SYNOPSIS" +.nf +#include + +size_t libcoopgamma_context_marshal(libcoopgamma_context_t* restrict \fIthis\fP, + void* restrict \fIbuffer\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_context_marshal () +function marshals +.I this +into a +.I buffer +that can be sent to another process on any computer +with a compatible processor. A compatible processor +is any processor with the same endianness, encoding +and sizes of the intrinsic data types and +.IR size_t . +However, it is probably nonsensical to send the +marshalled data to any other process than the +process itself since it contains a file descriptor. +.SH "RETURN VALUES" +The +.BR libcoopgamma_context_marshal () +returns the number of bytes stored in the +.IR buffer , +or if +.I buffer +is +.IR NULL , +the the number of bytes that would have +been written if it was not +.IR NULL . +The function is always successful. +.SH "SEE ALSO" +.BR libcoopgamma_context_destroy (3), +.BR libcoopgamma_context_unmarshal (3), +.BR libcoopgamma_ramps_marshal (3), +.BR libcoopgamma_filter_marshal (3), +.BR libcoopgamma_crtc_info_marshal (3), +.BR libcoopgamma_filter_query_marshal (3), +.BR libcoopgamma_queried_filter_marshal (3), +.BR libcoopgamma_filter_table_marshal (3), +.BR libcoopgamma_error_marshal (3), +.BR libcoopgamma_async_context_marshal (3) -- cgit v1.2.3-70-g09d2