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>natural_t</strong>                <var>mps_pset_count</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>mach_port_srights_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 Containing port set.
  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.  Valid values are as follows:
  53      <dl>
  54        <p>
  55        <dt> MPS_FALSE
  56             <dd>
  57                  No send rights currently in existence.
  58                         <p>
  59        <dt> MPS_TRUE
  60             <dd>
  61                  Send rights exist and no-more-senders notification is enabled.
  62                         <p>
  63        <dt> MPS_UNKNOWN
  64             <dd>
  65                  The port does not permit no-more-senders notification requests;
  66                  consequently, the system does not know whether or not send rights
  67                  exist.
  68                  </dl>
  69      <p>
  70 <dt> <var>mps_pdrequest</var>
  71 <dd>
  72      Specifies whether or not a port-deleted notification has been requested.
  73      <p>
  74 <dt> <var>mps_nsrequest</var>
  75 <dd>
  76 True if no-senders requested.
  77           <p>
  78 <dt> <var>mps_flags</var>
  79 <dd>
  80      Flags associated with the port.
  81 </dl>
  82 <h3>DESCRIPTION</h3>
  83 <p>
  84 The <strong>mach_port_status</strong> structure is used to provide
  85 information about a port in response to an invocation of the
  86 <strong>mach_port_get_attributes</strong> interface.
  87 <h3>NOTES</h3>
  88 <p>
  89 This structure is machine word length sensitive due
  90 to the presence of the port
  91 set name.
  92 <h3>RELATED INFORMATION</h3>
  93 <p>
  94 Functions:
  95 <a href="mach_port_get_attributes.html"><strong>mach_port_get_attributes</strong></a>.