1 .\"
2 .\" Mach Operating System
3 .\" Copyright (c) 1991,1990 Carnegie Mellon University
4 .\" All Rights Reserved.
5 .\"
6 .\" Permission to use, copy, modify and distribute this software and its
7 .\" documentation is hereby granted, provided that both the copyright
8 .\" notice and this permission notice appear in all copies of the
9 .\" software, derivative works or modified versions, and any portions
10 .\" thereof, and that both notices appear in supporting documentation.
11 .\"
12 .\" CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
13 .\" CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
14 .\" ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
15 .\"
16 .\" Carnegie Mellon requests users of this software to return to
17 .\"
18 .\" Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
19 .\" School of Computer Science
20 .\" Carnegie Mellon University
21 .\" Pittsburgh PA 15213-3890
22 .\"
23 .\" any improvements or extensions that they make and grant Carnegie Mellon
24 .\" the rights to redistribute these changes.
25 .\"
26 .\"
27 .\" HISTORY
28 .\" $Log: mach_port_get_receive_status.man,v $
29 .\" Revision 2.6 93/05/10 19:31:16 rvb
30 .\" updated
31 .\" [93/04/21 16:03:26 lli]
32 .\"
33 .\" Revision 2.5 91/12/11 08:42:55 jsb
34 .\" Updated for MK62 (sequence numbers).
35 .\" [91/11/26 11:01:25 rpd]
36 .\"
37 .\" Changed <mach/mach.h> to <mach.h>.
38 .\" [91/11/25 10:55:24 rpd]
39 .\"
40 .\" Revision 2.4 91/05/14 17:06:23 mrt
41 .\" Correcting copyright
42 .\"
43 .\" Revision 2.3 91/02/14 14:11:15 mrt
44 .\" Changed to new Mach copyright
45 .\" [91/02/12 18:11:27 mrt]
46 .\"
47 .\" Revision 2.2 90/08/07 18:36:50 rpd
48 .\" Created.
49 .\"
50 .TH mach_port_get_receive_status 2 1/13/87
51 .CM 4
52 .SH NAME
53 .nf
54 mach_port_get_receive_status \- returns the status of a receive right
55 .SH SYNOPSIS
56 .nf
57 .ft B
58 #include <mach.h>
59
60 kern_return_t
61 mach_port_get_receive_status(task, name, status)
62 mach_port_t task;
63 mach_port_t name;
64 mach_port_status_t *status; /* out */
65
66 typedef unsigned int mach_port_seqno_t;
67 typedef unsigned int mach_port_mscount_t;
68 typedef unsigned int mach_port_msgcount_t;
69 typedef unsigned int mach_port_rights_t;
70
71 typedef struct mach_port_status {
72 mach_port_t mps_pset; /* containing port set */
73 mach_port_seqno_t mps_seqno; /* sequence number */
74 mach_port_mscount_t mps_mscount; /* make-send count */
75 mach_port_msgcount_t mps_qlimit; /* queue limit */
76 mach_port_msgcount_t mps_msgcount; /* number in the queue */
77 mach_port_rights_t mps_sorights; /* how many send-once rights */
78 boolean_t mps_srights; /* do send rights exist? */
79 boolean_t mps_pdrequest; /* port-deleted requested? */
80 boolean_t mps_nsrequest; /* no-senders requested? */
81 } mach_port_status_t;
82 .fi
83 .ft P
84 .SH ARGUMENTS
85 .TP 12
86 .B
87 task
88 The task holding the receive right.
89 .TP 12
90 .B
91 name
92 The task's name for the receive right.
93 .TP 12
94 .B
95 status
96 The status information for the receive right.
97 .SH DESCRIPTION
98 \fBmach_port_get_receive_status\fR
99 returns the current status of the specified receive right.
100 .SH DIAGNOSTICS
101 .TP 25
102 KERN_SUCCESS
103 The call succeeded.
104 .TP 25
105 KERN_INVALID_TASK
106 \fBtask\fR was invalid.
107 .TP 25
108 KERN_INVALID_NAME
109 \fBname\fR did not denote a right.
110 .TP 25
111 KERN_INVALID_RIGHT
112 \fBname\fR denoted a right, but not a receive right.
113 .PP
114 The \fBmach_port_get_receive_status\fR call is actually an RPC to \fBtask\fR,
115 normally a send right for a task port, but potentially any send right.
116 In addition to the normal diagnostic
117 return codes from the call's server (normally the kernel),
118 the call may return \fBmach_msg(2)\fR return codes.
119 .SH SEE ALSO
120 mach_port_set_qlimit(2),
121 mach_port_set_mscount(2),
122 mach_port_set_seqno(2).
Cache object: bdde9b551318f8d66541c803fd4fed07
|