Skip to content

Commit

Permalink
doc/flux_rpc(3): rename rpcf->rpc_pack, getf->get_unpack
Browse files Browse the repository at this point in the history
  • Loading branch information
garlick committed Jul 10, 2017
1 parent 5c9707e commit c1c36c8
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
8 changes: 4 additions & 4 deletions doc/man3/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,10 @@ MAN3_FILES_SECONDARY = \
flux_future_aux_get.3 \
flux_future_set_flux.3 \
flux_future_get_flux.3 \
flux_rpcf.3 \
flux_rpc_pack.3 \
flux_rpc_raw.3 \
flux_rpc_get.3 \
flux_rpc_getf.3 \
flux_rpc_get_unpack.3 \
flux_rpc_get_raw.3 \
flux_kvs_lookupat.3 \
flux_kvs_lookup_get.3 \
Expand Down Expand Up @@ -216,10 +216,10 @@ flux_future_aux_set.3: flux_future_create.3
flux_future_aux_get.3: flux_future_create.3
flux_future_set_flux.3: flux_future_create.3
flux_future_get_flux.3: flux_future_create.3
flux_rpcf.3: flux_rpc.3
flux_rpc_pack.3: flux_rpc.3
flux_rpc_raw.3: flux_rpc.3
flux_rpc_get.3: flux_rpc.3
flux_rpc_getf.3: flux_rpc.3
flux_rpc_get_unpack.3: flux_rpc.3
flux_rpc_get_raw.3: flux_rpc.3
flux_kvs_lookupat.3: flux_kvs_lookup.3
flux_kvs_get.3: flux_kvs_lookup.3
Expand Down
30 changes: 15 additions & 15 deletions doc/man3/flux_rpc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ flux_rpc(3)

NAME
----
flux_rpc, flux_rpcf, flux_rpc_raw, flux_rpc_get, flux_rpc_getf, flux_rpc_get_raw - perform a remote procedure call to a Flux service
flux_rpc, flux_rpc_pack, flux_rpc_raw, flux_rpc_get, flux_rpc_get_unpack, flux_rpc_get_raw - perform a remote procedure call to a Flux service


SYNOPSIS
Expand All @@ -16,17 +16,17 @@ SYNOPSIS
const char *json_str,
uint32_t nodeid, int flags);

flux_future_t *flux_rpcf (flux_t *h, const char *topic,
uint32_t nodeid, int flags,
const char *fmt, ...);
flux_future_t *flux_rpc_pack (flux_t *h, const char *topic,
uint32_t nodeid, int flags,
const char *fmt, ...);

flux_future_t *flux_rpc_raw (flux_t *h, const char *topic,
const void *data, int len,
uint32_t nodeid, int flags);

int flux_rpc_get (flux_future_t *f, const char **json_str);

int flux_rpc_getf (flux_future_t *f, const char *fmt, ...);
int flux_rpc_get_unpack (flux_future_t *f, const char *fmt, ...);

int flux_rpc_get_raw (flux_future_t *f, void *data, int *len);

Expand All @@ -36,7 +36,7 @@ DESCRIPTION
A remote procedure call (RPC) consists of a matched request and
response message exchanged with a Flux service. `flux_rpc()`,
`flux_rpcf()`, and `flux_rpc_raw()` encode and send a request message
`flux_rpc_pack()`, and `flux_rpc_raw()` encode and send a request message
via Flux broker handle _h_ to a Flux service identified by _topic_
and _nodeid_. A `flux_future_t` object is returned which acts as a handle
for synchronization and a container for the response message which in
Expand All @@ -47,7 +47,7 @@ turn contains the RPC result.
`flux_future_wait_for(3)` may be used to block until the
response has been received. Both accept an optional timeout.
`flux_rpc_get()`, `flux_rpc_getf()`, and `flux_rpc_get_raw()`
`flux_rpc_get()`, `flux_rpc_get_unpack()`, and `flux_rpc_get_raw()`
decode the RPC result. Internally, they call `flux_future_get()`
to access the response message stored in the future. If the response
message has not yet been received, these functions block until it is,
Expand All @@ -63,8 +63,8 @@ using one of the three `flux_rpc()` variants.
`flux_rpc()` attaches _json_str_, a serialized JSON string, as request
payload. If NULL, the request is encoded without a payload.

`flux_rpcf()` attaches a JSON payload encoded using Jansson `json_pack()`
style arguments (see below).
`flux_rpc_pack()` attaches a JSON payload encoded using Jansson
`json_pack()` style arguments (see below).

`flux_rpc_raw()` attaches a raw payload _data_ of length _len_, in bytes.
If _data_ is NULL, the request is encoded without a payload.
Expand Down Expand Up @@ -103,9 +103,9 @@ return an error.
payload contained in the RPC response. If there was no payload, _json_str_
is set to NULL.
`flux_rpc_getf()` decodes the JSON payload using Jansson `json_unpack()` style
arguments (see below). It is an error if there is no payload, or if the
payload is not JSON.
`flux_rpc_get_unpack()` decodes the JSON payload using Jansson `json_unpack()`
style arguments (see below). It is an error if there is no payload, or if
the payload is not JSON.
`flux_rpc_get_raw()` assigns the raw payload of the RPC response message
to _data_ and its length to _len_. If there is no payload, this function
Expand Down Expand Up @@ -135,11 +135,11 @@ on that handle.
RETURN VALUE
------------
`flux_rpc()`, `flux_rpcf()`, and `flux_rpc_raw()` return a flux_future_t
`flux_rpc()`, `flux_rpc_pack()`, and `flux_rpc_raw()` return a flux_future_t
object on success. On error, NULL is returned, and errno is set appropriately.
`flux_rpc_get()`, `flux_rpc_getf()`, and `flux_rpc_get_raw()` returns zero on
success. On error, -1 is returned, and errno is set appropriately.
`flux_rpc_get()`, `flux_rpc_get_unpack()`, and `flux_rpc_get_raw()` return
zero on success. On error, -1 is returned, and errno is set appropriately.
ERRORS
Expand Down

0 comments on commit c1c36c8

Please sign in to comment.