diff options
Diffstat (limited to 'lib/libcasper/libcasper/libcasper_service.3')
-rw-r--r-- | lib/libcasper/libcasper/libcasper_service.3 | 46 |
1 files changed, 22 insertions, 24 deletions
diff --git a/lib/libcasper/libcasper/libcasper_service.3 b/lib/libcasper/libcasper/libcasper_service.3 index c0656a23a572..201c19c70234 100644 --- a/lib/libcasper/libcasper/libcasper_service.3 +++ b/lib/libcasper/libcasper/libcasper_service.3 @@ -22,9 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $FreeBSD$ -.\" -.Dd May 5, 2020 +.Dd November 15, 2021 .Dt LIBCASPER 3 .Os .Sh NAME @@ -47,7 +45,7 @@ typedef int service_command_func_t(const char *, const nvlist_t *, nvlist_t *, .Sh DESCRIPTION The .Nm CREATE_SERVICE -macro to create a new Casper service. +macro is used to create a new casper service. The .Fa name is a string containing the service name, which will be used in the @@ -57,45 +55,45 @@ function to identify it. The .Fa limit_func is a function of type -.Li service_limit_func_t . -The first argument of the function contains +.Li service_limit_func_t +where the first argument of the function contains an .Xr nvlist 9 , -old service limits and second one the new limits. -If the services wasn't limited the old limits will be set to +old service limits and +the second argument contains the new limits. +If the service was not limited then the old limits will be set to .Dv NULL . -This function should not allow to extend service limits and only limit it -further. +This function must not allow the extension of service limits. The .Fa command_func is a function of type -.Li service_command_func_t . -First argument is the name of the command that should be executed. +.Li service_command_func_t +where the first argument is the name of the command that should be executed. The first .Xr nvlist 9 -contains the current limits. -Next one contains a +contains the current limits and the second contains an .Xr nvlist 9 -with current request. -The last one contains an output +with the current request. +The last argument contains a return value .Xr nvlist 9 -which contains the response from Casper. +which contains the response from casper. .Pp The .Fa flags -argument defines limits of the service. +argument defines the limits of the service. The supported flags are: .Bl -ohang -offset indent .It CASPER_SERVICE_STDIO -The Casper service has access to the stdio descriptors from the process it was +The casper service has access to the stdio descriptors from the process it was spawned from. .It CASPER_SERVICE_FD -The Casper service has access to all descriptors besides stdio descriptors from -the process it was spawned from. +The casper service has access to all of the descriptors, +besides the stdio descriptors, +from the process it was spawned from. .It CASPER_SERVICE_NO_UNIQ_LIMITS -The whole Casper communication is using +The whole casper communication is using an .Xr nvlist 9 -with -.Xr NVLIST_NO_UNIQ 9 +with the +.Dv NV_FLAG_NO_UNIQUE flag. .El .Sh SEE ALSO |