diff options
| author | Mattias Andrée <maandree@kth.se> | 2019-10-22 18:59:27 +0200 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2019-10-22 18:59:27 +0200 |
| commit | bf4020471356938b9181a33984f511ffdd7ff25b (patch) | |
| tree | 7f9a9abd1ae51318cd435f0ed7471be5f33b478c /libcoopgamma_ramps_marshal.3 | |
| parent | List radharc's priority (diff) | |
| download | libcoopgamma-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 'libcoopgamma_ramps_marshal.3')
| -rw-r--r-- | libcoopgamma_ramps_marshal.3 | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/libcoopgamma_ramps_marshal.3 b/libcoopgamma_ramps_marshal.3 new file mode 100644 index 0000000..aed8509 --- /dev/null +++ b/libcoopgamma_ramps_marshal.3 @@ -0,0 +1,66 @@ +.TH LIBCOOPGAMMA_RAMPS_MARSHAL 3 LIBCOOPGAMMA +.SH "NAME" +libcoopgamma_ramps_marshal - Marshal a member type of libcoopgamma_ramps_t +.SH "SYNOPSIS" +.nf +#include <libcoopgamma.h> + +size_t libcoopgamma_ramps_marshal(void *restrict \fIthis\fP, void *restrict \fIbuffer\fP); +.fi +.P +Link with +.IR -lcoopgamma . +.SH "DESCRIPTION" +The +.BR libcoopgamma_ramps_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 . +.P +.I this +must be of any of the following types, and not casted +to any other type such as +.I void* +or +.IR libcoopgamma_ramps_t: +.IR libcoopgamma_ramps8_t , +.IR libcoopgamma_ramps16_t , +.IR libcoopgamma_ramps32_t , +.IR libcoopgamma_ramps64_t , +.IR libcoopgamma_rampsf_t , +or +.IR libcoopgamma_rampsd_t . +.P +The +.BR libcoopgamma_ramps_marshal () +function is defined as a macro. +.SH "RETURN VALUES" +The +.BR libcoopgamma_ramps_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_ramps_destroy (3), +.BR libcoopgamma_ramps_unmarshal (3), +.BR libcoopgamma_ramps_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_context_marshal (3), +.BR libcoopgamma_async_context_marshal (3) |