aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libcoopgamma_context_marshal.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2019-10-22 18:59:27 +0200
committerMattias Andrée <maandree@kth.se>2019-10-22 18:59:27 +0200
commitbf4020471356938b9181a33984f511ffdd7ff25b (patch)
tree7f9a9abd1ae51318cd435f0ed7471be5f33b478c /doc/man/libcoopgamma_context_marshal.3
parentList radharc's priority (diff)
downloadlibcoopgamma-bf4020471356938b9181a33984f511ffdd7ff25b.tar.gz
libcoopgamma-bf4020471356938b9181a33984f511ffdd7ff25b.tar.bz2
libcoopgamma-bf4020471356938b9181a33984f511ffdd7ff25b.tar.xz
Change license, change style, clean up, flat file hier, clean valgrind output in test
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'doc/man/libcoopgamma_context_marshal.3')
-rw-r--r--doc/man/libcoopgamma_context_marshal.352
1 files changed, 0 insertions, 52 deletions
diff --git a/doc/man/libcoopgamma_context_marshal.3 b/doc/man/libcoopgamma_context_marshal.3
deleted file mode 100644
index aa7feea..0000000
--- a/doc/man/libcoopgamma_context_marshal.3
+++ /dev/null
@@ -1,52 +0,0 @@
-.TH LIBCOOPGAMMA_CONTEXT_MARSHAL 3 LIBCOOPGAMMA
-.SH "NAME"
-libcoopgamma_context_marshal - Marshal a libcoopgamma_context_t
-.SH "SYNOPSIS"
-.nf
-#include <libcoopgamma.h>
-
-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 ()
-function 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)