X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/9bccf70c0258c7cac2dcb80011b2a964d884c552..39236c6e673c41db228275375ab7fdb0f837b292:/osfmk/man/mach_port_status.html diff --git a/osfmk/man/mach_port_status.html b/osfmk/man/mach_port_status.html old mode 100755 new mode 100644 index 649a4132a..99e5a8cd1 --- a/osfmk/man/mach_port_status.html +++ b/osfmk/man/mach_port_status.html @@ -1 +1,74 @@ -

mach_port_status


Structure - Used to present a port's current status with respect to various important attributes.

SYNOPSIS

struct mach_port_status
{
       natural_t                mps_pset_count;
       mach_port_seqno_t         mps_seqno;
       mach_port_mscount_t     mps_mscount;
       mach_port_msgcount_t     mps_qlimit;
       mach_port_msgcount_t   mps_msgcount;
       mach_port_rights_t     mps_sorights;
       mach_port_srights_t     mps_srights;
       boolean_t             mps_pdrequest;
       boolean_t             mps_nsrequest;
       unsigned int              mps_flags;
};

typedef struct mach_port_status mach_port_status_t;

FIELDS

mps_pset
Containing port set.

mps_seqno
Current sequence number for the port.

mps_mscount
Make-send count.

mps_msgcount
Upper limit for the number of messages that may be queued to the port before the system blocks send operations.

mps_msgcount
Number of messages currently queued on the port.

mps_sorights
How many send-once rights.

mps_srights
Specifies whether or not send rights exist. Valid values are as follows:

MPS_FALSE
No send rights currently in existence.

MPS_TRUE
Send rights exist and no-more-senders notification is enabled.

MPS_UNKNOWN
The port does not permit no-more-senders notification requests; consequently, the system does not know whether or not send rights exist.

mps_pdrequest
Specifies whether or not a port-deleted notification has been requested.

mps_nsrequest
True if no-senders requested.

mps_flags
Flags associated with the port.

DESCRIPTION

The mach_port_status structure is used to provide information about a port in response to an invocation of the mach_port_get_attributes interface.

NOTES

This structure is machine word length sensitive due to the presence of the port set name.

RELATED INFORMATION

Functions: mach_port_get_attributes. \ No newline at end of file +

mach_port_status

+
+

+Structure - Used to present a port's current status with respect to various important attributes. +

SYNOPSIS

+
+struct mach_port_status
+{
+       mach_port_rights_t         mps_pset;
+       mach_port_seqno_t         mps_seqno;
+       mach_port_mscount_t     mps_mscount;
+       mach_port_msgcount_t     mps_qlimit;
+       mach_port_msgcount_t   mps_msgcount;
+       mach_port_rights_t     mps_sorights;
+       boolean_t               mps_srights;
+       boolean_t             mps_pdrequest;
+       boolean_t             mps_nsrequest;
+       unsigned int              mps_flags;
+};
+
+typedef struct mach_port_status mach_port_status_t;
+
+

FIELDS

+
+
mps_pset +
+Count of containing psets. +

+

mps_seqno +
+Current sequence number for the port. +

+

mps_mscount +
+ Make-send count. +

+

mps_msgcount +
+ Upper limit for the number of messages that may be queued to the port + before the system blocks send operations. +

+

mps_msgcount +
+ Number of messages currently queued on the port. +

+

mps_sorights +
+ How many send-once rights. +

+

mps_srights +
+ Specifies whether or not send rights exist for the port (in this or any other task). +

+

mps_pdrequest +
+ Specifies whether or not a port-deleted notification has been requested. +

+

mps_nsrequest +
+ True if no-senders notification requested. +

+

mps_flags +
+ Flags associated with the port. +
+

DESCRIPTION

+

+The mach_port_status structure is used to provide +information about a port in response to an invocation of the +mach_port_get_attributes interface. +

RELATED INFORMATION

+

+Functions: +mach_port_get_attributes.