forked from flux-framework/flux-core
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Problem: there's no RTD documentation for flux_msg_incref, which is a useful function for streaming RPCs. Add it.
- Loading branch information
Showing
3 changed files
with
77 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
========================== | ||
flux_msg_create(3) | ||
========================== | ||
|
||
.. default-domain:: c | ||
|
||
SYNOPSIS | ||
======== | ||
|
||
.. code-block:: c | ||
#include <flux/core.h> | ||
flux_msg_t *flux_msg_create (int type) | ||
flux_msg_t *flux_msg_copy (const flux_msg_t *msg, bool payload) | ||
const flux_msg_t *flux_msg_incref (const flux_msg_t *const_msg) | ||
void flux_msg_decref (const flux_msg_t *const_msg) | ||
void flux_msg_destroy (flux_msg_t *msg) | ||
DESCRIPTION | ||
=========== | ||
|
||
:func:`flux_msg_create` creates a `flux_msg_t` of `int type`. Different types | ||
of Flux messages are defined `RFC 6 <https://flux-framework.readthedocs.io/ | ||
projects/flux-rfc/en/latest/spec_6.html>_`. | ||
|
||
:func:`flux_msg_copy` copies the attributes of a `flux_msg_t` object into a new | ||
`flux_msg_t` object. | ||
|
||
:func:`flux_msg_incref` provides a constant pointer to a `flux_msg_t` object. | ||
It also increments the reference count of the object by 1. | ||
|
||
:func:`flux_msg_decref` decrements the reference count of a `flux_msg_t` object | ||
by 1. When the reference count reaches 0, the message is destroyed. | ||
|
||
:func:`flux_msg_destroy` destroys a message. | ||
|
||
RETURN VALUE | ||
============ | ||
|
||
:func:`flux_msg_create` returns a `flux_msg_t` type. | ||
|
||
:func:`flux_msg_copy` returns a new `flux_msg_t` object with the same attributes | ||
as another `flux_msg_t` objects. | ||
|
||
:func:`flux_msg_incref` returns a constant pointer to a `flux_msg_t` object. | ||
|
||
:func:`flux_msg_decref` has no return value. | ||
|
||
:func:`flux_msg_destroy` has no return value. | ||
|
||
|
||
RESOURCES | ||
========= | ||
|
||
.. include:: common/resources.rst | ||
|
||
|
||
SEE ALSO | ||
======== | ||
|
||
:man3:`flux_send`, :man3:`flux_respond` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters