diff options
Diffstat (limited to 'usr/src/man/man4/contract.4')
| -rw-r--r-- | usr/src/man/man4/contract.4 | 62 |
1 files changed, 2 insertions, 60 deletions
diff --git a/usr/src/man/man4/contract.4 b/usr/src/man/man4/contract.4 index 185ffd938f..a6896a4e92 100644 --- a/usr/src/man/man4/contract.4 +++ b/usr/src/man/man4/contract.4 @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH contract 4 "11 Jul 2005" "SunOS 5.11" "File Formats" +.TH CONTRACT 4 "Jul 11, 2005" .SH NAME contract \- the contract file system .SH SYNOPSIS @@ -53,12 +53,10 @@ of the contracts' IDs. The following files are in a \fB/system/contract/\fItype\fR\fR directory: .sp .ne 2 -.mk .na \fB\fBtemplate\fR\fR .ad .RS 12n -.rt Opening this file returns a file descriptor for a new \fItype\fR contract template. .sp @@ -81,12 +79,10 @@ See TERMS for additional template functions. .sp .ne 2 -.mk .na \fBlatest\fR .ad .RS 12n -.rt Opening this file returns a file descriptor for the status file of the last \fItype\fR contract written by the opening LWP. See \fBSTRUCTURE OF /system/contract/\fItype\fR/\fIid\fR\fR. If the opening LWP has not created a @@ -95,12 +91,10 @@ Opening this file returns a file descriptor for the status file of the last .sp .ne 2 -.mk .na \fBbundle\fR .ad .RS 12n -.rt Opening this file returns a file descriptor for an event endpoint which receives events from all \fItype\fR contracts on the system. No privileges are required to open a type bundle event endpoint. Events sent by contracts owned @@ -111,12 +105,10 @@ that is, they are silently skipped, unless the reader has .sp .ne 2 -.mk .na \fBpbundle\fR .ad .RS 12n -.rt Opening this file returns a file descriptor for an event endpoint which receives events from all \fItype\fR contracts held by the opening process. See \fBEVENTS\fR. @@ -136,12 +128,10 @@ Each \fB/system/contract/\fItype\fR/\fIid\fR\fR directory contains the following files: .sp .ne 2 -.mk .na \fBctl\fR .ad .RS 10n -.rt Opening this file returns a file descriptor for contract \fIid\fR's control file. The open fails if the opening process does not hold contract \fIid\fR and the contract has not been inherited by the process contract of which the @@ -174,12 +164,10 @@ ct_ctl_adopt(3contract) .sp .ne 2 -.mk .na \fBstatus\fR .ad .RS 10n -.rt Opening this file returns a file descriptor for contract \fIid\fR's status file. The following \fBlibcontract\fR(3LIB) calls can be made on a status file descriptor: @@ -193,12 +181,10 @@ ct_status_read(3contract) .sp .ne 2 -.mk .na \fBevents\fR .ad .RS 10n -.rt Opening this file returns a file descriptor for an event endpoint which receives events from contract \fIid\fR. See \fBEVENTS\fR. .sp @@ -214,36 +200,30 @@ for a contract. The following terms are defined for all contracts: .sp .ne 2 -.mk .na \fBcookie\fR .ad .RS 25n -.rt Specifies a 64-bit quantity that the contract author can use to identify the contract. Use \fBct_tmpl_set_cookie\fR(3CONTRACT) to set this term. .RE .sp .ne 2 -.mk .na \fBinformative event set\fR .ad .RS 25n -.rt Selects which events are delivered as informative events. Use \fBct_tmpl_set_informative\fR(3CONTRACT) to set this term. .RE .sp .ne 2 -.mk .na \fBcritical event set\fR .ad .RS 25n -.rt Selects which events are delivered as critical events. Use \fBct_tmpl_set_critical\fR(3CONTRACT) to set this term. .RE @@ -255,7 +235,6 @@ A status object returned by \fBct_status_read\fR(3CONTRACT) contains the following pieces of information: .sp .ne 2 -.mk .na \fBcontract ID\fR .ad @@ -267,7 +246,6 @@ this information. .sp .ne 2 -.mk .na \fBcontract type\fR .ad @@ -280,7 +258,6 @@ subdirectory name under \fB/system/contract\fR. .sp .ne 2 -.mk .na \fBcreator's zone ID\fR .ad @@ -292,7 +269,6 @@ The zone ID of the process which created the contract. Obtained using .sp .ne 2 -.mk .na \fBownership state\fR .ad @@ -305,7 +281,6 @@ to obtain this information. .sp .ne 2 -.mk .na \fBcontract holder\fR .ad @@ -320,7 +295,6 @@ to obtain this information. .sp .ne 2 -.mk .na \fBnumber of critical events\fR .ad @@ -332,7 +306,6 @@ queue. Use \fBct_status_get_nevents\fR(3CONTRACT) to obtain this information. .sp .ne 2 -.mk .na \fBnegotiation time\fR .ad @@ -344,7 +317,6 @@ The time remaining before the current synchronous negotiation times out. Use .sp .ne 2 -.mk .na \fBnegotiation quantum time\fR .ad @@ -356,7 +328,6 @@ The time remaining before the current negotiation quantum runs out. Use .sp .ne 2 -.mk .na \fBnegotiation event ID\fR .ad @@ -368,7 +339,6 @@ The ID of the event which initiated the negotiation timeout. Use .sp .ne 2 -.mk .na \fBcookie (term)\fR .ad @@ -380,7 +350,6 @@ this information. .sp .ne 2 -.mk .na \fBInformative event set (term)\fR .ad @@ -392,7 +361,6 @@ The contract's informative event set. Use .sp .ne 2 -.mk .na \fBCritical event set (term)\fR .ad @@ -418,7 +386,7 @@ endpoint file descriptor: .nf ct_event_read(3contract) ct_event_read_critical(3contract) -ct_event_reset(3contract) +ct_event_reset(3contract) ct_event_next(3contract) .fi .in -2 @@ -435,47 +403,39 @@ An event object returned by \fBct_event_read\fR(3CONTRACT) contains the following information: .sp .ne 2 -.mk .na \fBcontract ID\fR .ad .RS 28n -.rt The ID of the contract that generated the event. Use \fBct_event_read\fR(3CONTRACT) to obtain this information. .RE .sp .ne 2 -.mk .na \fBevent ID\fR .ad .RS 28n -.rt The ID of the contract event.Use \fBct_event_get_evid\fR(3CONTRACT). .RE .sp .ne 2 -.mk .na \fBflags\fR .ad .RS 28n -.rt A bit vector possibly including \fBCT_ACK\fR and \fBCTE_INFO\fR. Use \fBct_event_get_flags\fR(3CONTRACT) to obtain this information. .RE .sp .ne 2 -.mk .na \fBevent type\fR .ad .RS 28n -.rt The type of event, equal to one of the constants specified in the contract type's manual page or \fBCT_EV_NEGEND\fR. Use \fBct_event_get_type\fR(3CONTRACT) to obtain this information. @@ -487,12 +447,10 @@ type's manual page or \fBCT_EV_NEGEND\fR. Use The following event types are defined: .sp .ne 2 -.mk .na \fB\fBCT_EV_NEGEND\fR\fR .ad .RS 16n -.rt Some time after an exit negotiation is initiated, the \fBCT_EV_NEGEND\fR event is sent. This indicates that the negotiation ended. This might be because the operation was cancelled, or because the operation was successful. If @@ -508,24 +466,20 @@ contract. A \fBCT_EV_NEGEND\fR event contains: .sp .ne 2 -.mk .na \fBnegotiation ID\fR .ad .RS 19n -.rt The ID of the negotiation which ended. Use \fBct_event_get_nevid\fR(3CONTRACT) to obain this information. .RE .sp .ne 2 -.mk .na \fBnew contract ID\fR .ad .RS 19n -.rt The ID of the newly created contract. This value is 0 if no contract was created, or the ID of the existing contract if the operation was not completed. Use \fBct_event_get_newct\fR(3CONTRACT) to obtain this information. @@ -536,7 +490,6 @@ Use \fBct_event_get_newct\fR(3CONTRACT) to obtain this information. .SH FILES .sp .ne 2 -.mk .na \fB\fB/system/contract\fR\fR .ad @@ -547,7 +500,6 @@ List of all contract types .sp .ne 2 -.mk .na \fB\fB/system/contract/all\fR\fR .ad @@ -558,7 +510,6 @@ Directory of all contract IDs .sp .ne 2 -.mk .na \fB\fB/system/contract/all/\fIid\fR\fR\fR .ad @@ -569,7 +520,6 @@ Symbolic link to the type-specific directory of contract \fIid\fR .sp .ne 2 -.mk .na \fB\fB/system/contract/\fItype\fR\fR\fR .ad @@ -580,7 +530,6 @@ Specific type directory .sp .ne 2 -.mk .na \fB\fB/system/contract/\fItype\fR/templete\fR\fR .ad @@ -591,7 +540,6 @@ Template for the contract type .sp .ne 2 -.mk .na \fB\fB/system/contract/\fItype\fR/bundle\fR\fR .ad @@ -602,7 +550,6 @@ Listening point for all contracts of that type .sp .ne 2 -.mk .na \fB\fB/system/contract/\fItype\fR/pbundle\fR\fR .ad @@ -613,7 +560,6 @@ Listening point for all contracts of that type for the opening process .sp .ne 2 -.mk .na \fB\fB/system/contract/\fItype\fR /latest\fR\fR .ad @@ -624,7 +570,6 @@ Status of most recent \fItype\fR contract created by the opening LWP .sp .ne 2 -.mk .na \fB\fB/system/contract/\fItype\fR/\fIID\fR\fR\fR .ad @@ -635,7 +580,6 @@ Directory for contract id .sp .ne 2 -.mk .na \fB\fB/system/contract/\fItype\fR/\fIID\fR/events\fR\fR .ad @@ -646,7 +590,6 @@ Listening point for contract id's events .sp .ne 2 -.mk .na \fB\fB/system/contract/\fItype\fR/\fIID\fR/ctl\fR\fR .ad @@ -657,7 +600,6 @@ Control file for contract ID .sp .ne 2 -.mk .na \fB\fB/system/contract/\fItype\fR/\fIID\fR/status\fR\fR .ad |