diff options
Diffstat (limited to 'libcoopgamma_context_marshal.3')
| -rw-r--r-- | libcoopgamma_context_marshal.3 | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/libcoopgamma_context_marshal.3 b/libcoopgamma_context_marshal.3 new file mode 100644 index 0000000..aa7feea --- /dev/null +++ b/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 <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) |