[apple/xnu.git] / osfmk / man / mach_port_status.html

<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