From d00050a5a0a8193c5956174461ab99da34d98158 Mon Sep 17 00:00:00 2001 From: Jim Garlick Date: Mon, 13 Nov 2017 11:33:56 -0800 Subject: [PATCH] doc/flux_msg_handler_create(3): define more roles Add FLUX_ROLEMASK_NONE and FLUX_ROLEMASK_ALL and make sure to be clear that allow/deny modify, not overwrite, the existing rolemask. --- doc/man3/flux_msg_handler_create.adoc | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/doc/man3/flux_msg_handler_create.adoc b/doc/man3/flux_msg_handler_create.adoc index 590f1a196b44..934f944ca718 100644 --- a/doc/man3/flux_msg_handler_create.adoc +++ b/doc/man3/flux_msg_handler_create.adoc @@ -79,10 +79,11 @@ A message handler only receives a message if a bit-wise and of the message rolemask and the message handler rolemask evaluates to a non-zero value, or the message rolemask contains the FLUX_ROLE_OWNER (instance owner) role. -By default, the message handler rolemask is 0, but may be changed with -`flux_msg_handler_allow_rolemask()` and `flux_msg_handler_deny_rolemask()`, -which add or remove roles from the message handler rolemask. The -FLUX_ROLE_OWNER bit position is ignored in the message handler rolemask. +By default, the message handler rolemask is 0, but roles may be added +to the existing message handler rolemask with +`flux_msg_handler_allow_rolemask()` or removed from it with +`flux_msg_handler_deny_rolemask()`. The FLUX_ROLE_OWNER bit position +is ignored in the message handler rolemask. The following roles are defined in RFC 12: @@ -92,6 +93,14 @@ The instance owner role has maximum privilege within the Flux instance. FLUX_ROLE_USER:: The user role confers access, but not administrative privilege. +In addition, RFC 12 defines these symbolic rolemask values: + +FLUX_ROLE_NONE:: +The empty set. + +FLUX_ROLE_ALL:: +The set of all possible roles. + Other roles are yet to be defined.