]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/man/mach_port_status.html
xnu-792.6.76.tar.gz
[apple/xnu.git] / osfmk / man / mach_port_status.html
index 649a4132ae241759f9debebcc86f201bc9db7f3f..1e9b8d74e2ae606510a445e0b958e69271a9d218 100755 (executable)
@@ -1 +1,95 @@
-<h2>mach_port_status</h2>\r<hr>\r<p>\r<strong>Structure</strong> - Used to present a port's current status with respect to various important attributes.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>struct mach_port_status</strong>\r<strong>{</strong>\r       <strong>natural_t</strong>                <var>mps_pset_count</var><strong>;</strong>\r       <strong>mach_port_seqno_t</strong>         <var>mps_seqno</var><strong>;</strong>\r       <strong>mach_port_mscount_t</strong>     <var>mps_mscount</var><strong>;</strong>\r       <strong>mach_port_msgcount_t</strong>     <var>mps_qlimit</var><strong>;</strong>\r       <strong>mach_port_msgcount_t</strong>   <var>mps_msgcount</var><strong>;</strong>\r       <strong>mach_port_rights_t</strong>     <var>mps_sorights</var><strong>;</strong>\r       <strong>mach_port_srights_t</strong>     <var>mps_srights</var><strong>;</strong>\r       <strong>boolean_t</strong>             <var>mps_pdrequest</var><strong>;</strong>\r       <strong>boolean_t</strong>             <var>mps_nsrequest</var><strong>;</strong>\r       <strong>unsigned int</strong>              <var>mps_flags</var><strong>;</strong>\r<strong>};</strong>\r\r<strong>typedef struct mach_port_status mach_port_status_t;</strong>\r</pre>\r<h3>FIELDS</h3>\r<dl>\r<dt> <var>mps_pset</var>\r<dd>\rContaining port set.\r     <p>\r<dt> <var>mps_seqno</var>\r<dd>\rCurrent sequence number for the port.\r     <p>\r     <dt> <var>mps_mscount</var>\r        <dd>\r        Make-send count.\r               <p>\r<dt> <var>mps_msgcount</var>\r<dd>\rUpper limit for the number of messages that may be queued to the port\r     before the system blocks send operations.\r     <p>\r     <dt> <var>mps_msgcount</var>\r<dd>\r     Number of messages currently queued on the port.\r     <p>\r<dt> <var>mps_sorights</var>\r<dd>\rHow many send-once rights.\r     <p>\r<dt> <var>mps_srights</var>\r<dd>\rSpecifies whether or not send rights exist.  Valid values are as follows:\r     <dl>\r       <p>\r       <dt> MPS_FALSE\r       <dd>\r                No send rights currently in existence.\r                        <p>\r       <dt> MPS_TRUE\r           <dd>\r                Send rights exist and no-more-senders notification is enabled.\r                        <p>\r       <dt> MPS_UNKNOWN\r        <dd>\r                The port does not permit no-more-senders notification requests;\r                consequently, the system does not know whether or not send rights\r              exist.\r                 </dl>\r     <p>\r<dt> <var>mps_pdrequest</var>\r<dd>\r     Specifies whether or not a port-deleted notification has been requested.\r     <p>\r<dt> <var>mps_nsrequest</var>\r<dd>\rTrue if no-senders requested.\r          <p>\r<dt> <var>mps_flags</var>\r<dd>\r     Flags associated with the port.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>mach_port_status</strong> structure is used to provide\rinformation about a port in response to an invocation of the\r<strong>mach_port_get_attributes</strong> interface.\r<h3>NOTES</h3>\r<p>\rThis structure is machine word length sensitive due\rto the presence of the port \rset name.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="mach_port_get_attributes.html"><strong>mach_port_get_attributes</strong></a>.\r
\ No newline at end of file
+<h2>mach_port_status</h2>
+<hr>
+<p>
+<strong>Structure</strong> - Used to present a port's current status with respect to various important attributes.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>struct mach_port_status</strong>
+<strong>{</strong>
+       <strong>natural_t</strong>                <var>mps_pset_count</var><strong>;</strong>
+       <strong>mach_port_seqno_t</strong>         <var>mps_seqno</var><strong>;</strong>
+       <strong>mach_port_mscount_t</strong>     <var>mps_mscount</var><strong>;</strong>
+       <strong>mach_port_msgcount_t</strong>     <var>mps_qlimit</var><strong>;</strong>
+       <strong>mach_port_msgcount_t</strong>   <var>mps_msgcount</var><strong>;</strong>
+       <strong>mach_port_rights_t</strong>     <var>mps_sorights</var><strong>;</strong>
+       <strong>mach_port_srights_t</strong>     <var>mps_srights</var><strong>;</strong>
+       <strong>boolean_t</strong>             <var>mps_pdrequest</var><strong>;</strong>
+       <strong>boolean_t</strong>             <var>mps_nsrequest</var><strong>;</strong>
+       <strong>unsigned int</strong>              <var>mps_flags</var><strong>;</strong>
+<strong>};</strong>
+
+<strong>typedef struct mach_port_status mach_port_status_t;</strong>
+</pre>
+<h3>FIELDS</h3>
+<dl>
+<dt> <var>mps_pset</var>
+<dd>
+Containing port set.
+     <p>
+<dt> <var>mps_seqno</var>
+<dd>
+Current sequence number for the port.
+     <p>
+     <dt> <var>mps_mscount</var>
+         <dd>
+              Make-send count.
+              <p>
+<dt> <var>mps_msgcount</var>
+<dd>
+Upper limit for the number of messages that may be queued to the port
+     before the system blocks send operations.
+     <p>
+     <dt> <var>mps_msgcount</var>
+<dd>
+     Number of messages currently queued on the port.
+     <p>
+<dt> <var>mps_sorights</var>
+<dd>
+How many send-once rights.
+     <p>
+<dt> <var>mps_srights</var>
+<dd>
+Specifies whether or not send rights exist.  Valid values are as follows:
+     <dl>
+       <p>
+       <dt> MPS_FALSE
+           <dd>
+                No send rights currently in existence.
+                       <p>
+       <dt> MPS_TRUE
+           <dd>
+                Send rights exist and no-more-senders notification is enabled.
+                       <p>
+       <dt> MPS_UNKNOWN
+           <dd>
+                The port does not permit no-more-senders notification requests;
+                consequently, the system does not know whether or not send rights
+                exist.
+                </dl>
+     <p>
+<dt> <var>mps_pdrequest</var>
+<dd>
+     Specifies whether or not a port-deleted notification has been requested.
+     <p>
+<dt> <var>mps_nsrequest</var>
+<dd>
+True if no-senders requested.
+          <p>
+<dt> <var>mps_flags</var>
+<dd>
+     Flags associated with the port.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>mach_port_status</strong> structure is used to provide
+information about a port in response to an invocation of the
+<strong>mach_port_get_attributes</strong> interface.
+<h3>NOTES</h3>
+<p>
+This structure is machine word length sensitive due
+to the presence of the port 
+set name.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="mach_port_get_attributes.html"><strong>mach_port_get_attributes</strong></a>.