Differential D14196 Diff 38932 lib/libcasper/libcasper/libcasper.3

Changeset View

Standalone View

lib/libcasper/libcasper/libcasper.3

Context not available.
	.\"	.\"
	.\" $FreeBSD$	.\" $FreeBSD$
	.\"	.\"
	.Dd January 3, 2018	.Dd February 4, 2018
	.Dt LIBCASPER 3	.Dt LIBCASPER 3
	.Os	.Os
	.Sh NAME	.Sh NAME
Context not available.
	.Ft "cap_channel_t *"	.Ft "cap_channel_t *"
	.Fn cap_init "void"	.Fn cap_init "void"
	.Ft "cap_channel_t *"	.Ft "cap_channel_t *"
	.Fn cap_wrap "int sock"	.Fn cap_wrap "int sock" "int flags"
	.Ft "int"	.Ft "int"
	.Fn cap_unwrap "cap_channel_t *chan"	.Fn cap_unwrap "cap_channel_t chan" "int flags"
	.Ft "int"	.Ft "int"
	.Fn cap_sock "const cap_channel_t *chan"	.Fn cap_sock "const cap_channel_t *chan"
	.Ft "cap_channel_t *"	.Ft "cap_channel_t *"
Context not available.
	.Ft "int"	.Ft "int"
	.Fn cap_send_nvlist "const cap_channel_t chan" "const nvlist_t nvl"	.Fn cap_send_nvlist "const cap_channel_t chan" "const nvlist_t nvl"
	.Ft "nvlist_t *"	.Ft "nvlist_t *"
	.Fn cap_recv_nvlist "const cap_channel_t *chan" "int flags"	.Fn cap_recv_nvlist "const cap_channel_t *chan"
	.Ft "nvlist_t *"	.Ft "nvlist_t *"
	.Fn cap_xfer_nvlist "const cap_channel_t chan" "nvlist_t nvl" "int flags"	.Fn cap_xfer_nvlist "const cap_channel_t chan" "nvlist_t nvl"
	.Ft "cap_channel_t *"	.Ft "cap_channel_t *"
	.Fn cap_service_open "const cap_channel_t chan" "const char name"	.Fn cap_service_open "const cap_channel_t chan" "const char name"
	.Sh DESCRIPTION	.Sh DESCRIPTION
Context not available.
	domain socket as a regular file descriptor and has to be represented as	domain socket as a regular file descriptor and has to be represented as
	.Vt cap_channel_t	.Vt cap_channel_t
	again.	again.
		The
		.Fa flags
		argument defines the channel behavior.
		The supported flags are:
		.Bl -ohang -offset indent
		.It CASPER_NO_UNIQ
		The communication between process and casper uses no unique version of nvlist.
		bcrUnsubmitted Done Inline Actions s/betwen/between/ bcr: s/betwen/between/
		bcrUnsubmitted Done Inline Actions s/uniq/unique/ bcr: s/uniq/unique/
		bruefferUnsubmitted Done Inline Actions use -> uses brueffer: use -> uses
		bruefferUnsubmitted Not Done Inline Actions Also, ".Xr nvlist 9" ? brueffer: Also, ".Xr nvlist 9" ?
		oshogboAuthorUnsubmitted Not Done Inline Actions We already are using the nvlist in this man doc and there is no reference to nvlist 9, do you thing we should do it here or in all places? oshogbo: We already are using the nvlist in this man doc and there is no reference to nvlist 9, do you…
		bruefferUnsubmitted Not Done Inline Actions I usually go for all places. brueffer: I usually go for all places.
		jillesUnsubmitted Not Done Inline Actions Does this correspond to `NV_FLAG_NO_UNIQUE` (names in nvlist need not be unique)? jilles: Does this correspond to `NV_FLAG_NO_UNIQUE` (names in nvlist need not be unique)?
		oshogboAuthorUnsubmitted Not Done Inline Actions Yes it is. oshogbo: Yes it is.
		.El
	.Pp	.Pp
	The	The
	.Fn cap_unwrap	.Fn cap_unwrap
Context not available.
	The	The
	.Fn cap_recv_nvlist	.Fn cap_recv_nvlist
	function receives the given nvlist over the given capability.	function receives the given nvlist over the given capability.
	The
	.Fa flags
	argument defines what type the top nvlist is expected to be.
	If the nvlist flags do not match the flags passed to
	.Fn cap_recv_nvlist ,
	the nvlist will not be returned.
	.Pp	.Pp
	The	The
	.Fn cap_xfer_nvlist	.Fn cap_xfer_nvlist
	function sends the given nvlist, destroys it and receives new nvlist in	function sends the given nvlist, destroys it and receives new nvlist in
	response over the given capability.	response over the given capability.
	The
	.Fa flags
	argument defines what type the top nvlist is expected to be.
	If the nvlist flags do not match the flags passed to
	.Fn cap_xfer_nvlist ,
	the nvlist will not be returned.
	It does not matter if the function succeeds or fails, the nvlist given	It does not matter if the function succeeds or fails, the nvlist given
	for sending will always be destroyed once the function returns.	for sending will always be destroyed once the function returns.
	.Pp	.Pp
Context not available.