osfmk/man/mach_port_status.html

   1 <h2>mach_port_status</h2>
   2 <hr>
   3 <p>
   4 <strong>Structure</strong> - Used to present a port's current status with respect to various important attributes.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>struct mach_port_status</strong>
   8 <strong>{</strong>
   9        <strong>mach_port_rights_t</strong>         <var>mps_pset</var><strong>;</strong>
  10        <strong>mach_port_seqno_t</strong>         <var>mps_seqno</var><strong>;</strong>
  11        <strong>mach_port_mscount_t</strong>     <var>mps_mscount</var><strong>;</strong>
  12        <strong>mach_port_msgcount_t</strong>     <var>mps_qlimit</var><strong>;</strong>
  13        <strong>mach_port_msgcount_t</strong>   <var>mps_msgcount</var><strong>;</strong>
  14        <strong>mach_port_rights_t</strong>     <var>mps_sorights</var><strong>;</strong>
  15        <strong>boolean_t</strong>               <var>mps_srights</var><strong>;</strong>
  16        <strong>boolean_t</strong>             <var>mps_pdrequest</var><strong>;</strong>
  17        <strong>boolean_t</strong>             <var>mps_nsrequest</var><strong>;</strong>
  18        <strong>unsigned int</strong>              <var>mps_flags</var><strong>;</strong>
  19 <strong>};</strong>
  20
  21 <strong>typedef struct mach_port_status mach_port_status_t;</strong>
  22 </pre>
  23 <h3>FIELDS</h3>
  24 <dl>
  25 <dt> <var>mps_pset</var>
  26 <dd>
  27 Count of containing psets.
  28      <p>
  29 <dt> <var>mps_seqno</var>
  30 <dd>
  31 Current sequence number for the port.
  32      <p>
  33      <dt> <var>mps_mscount</var>
  34           <dd>
  35                Make-send count.
  36                <p>
  37 <dt> <var>mps_msgcount</var>
  38 <dd>
  39      Upper limit for the number of messages that may be queued to the port
  40      before the system blocks send operations.
  41      <p>
  42 <dt> <var>mps_msgcount</var>
  43 <dd>
  44      Number of messages currently queued on the port.
  45      <p>
  46 <dt> <var>mps_sorights</var>
  47 <dd>
  48      How many send-once rights.
  49      <p>
  50 <dt> <var>mps_srights</var>
  51 <dd>
  52      Specifies whether or not send rights exist for the port (in this or any other task).
  53      <p>
  54 <dt> <var>mps_pdrequest</var>
  55 <dd>
  56      Specifies whether or not a port-deleted notification has been requested.
  57      <p>
  58 <dt> <var>mps_nsrequest</var>
  59 <dd>
  60      True if no-senders notification requested.
  61      <p>
  62 <dt> <var>mps_flags</var>
  63 <dd>
  64      Flags associated with the port.
  65 </dl>
  66 <h3>DESCRIPTION</h3>
  67 <p>
  68 The <strong>mach_port_status</strong> structure is used to provide
  69 information about a port in response to an invocation of the
  70 <strong>mach_port_get_attributes</strong> interface.
  71 <h3>RELATED INFORMATION</h3>
  72 <p>
  73 Functions:
  74 <a href="mach_port_get_attributes.html"><strong>mach_port_get_attributes</strong></a>.