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

<h2>mach_msg_descriptor</h2>\r<hr>\r<p>\r<strong>Structure</strong> - Specifies operations that must be performed on a given IPC message element.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>typedef struct</strong>\r<strong>{</strong>\r       <strong>void*</strong>                             <var>pad1</var><strong>;</strong>\r       <strong>mach_msg_size_t</strong>                   <var>pad2</var><strong>;</strong>\r       <strong>unsigned int</strong>                      <var>pad3</var><strong> : 24;</strong>\r       <strong>mach_msg_descriptor_type_t</strong>        <var>type</var><strong> : 8;</strong>\r<strong>} mach_msg_type_descriptor_t;</strong>\r\r<strong>typedef struct</strong>\r<strong>{</strong>\r       <strong>mach_port_t</strong>                       <var>name</var><strong>;</strong>\r       <strong>mach_msg_size_t</strong>                   <var>pad1</var><strong>;</strong>\r       <strong>unsigned int</strong>                      <var>pad2</var><strong> : 16;</strong>\r       <strong>mach_msg_type_name_t</strong>       <var>disposition</var><strong> : 8;</strong>\r       <strong>mach_msg_descriptor_type_t</strong>        <var>type</var><strong> : 8;</strong>\r<strong>} mach_msg_port_descriptor_t;</strong>\r\r<strong>typedef struct</strong>\r<strong>{</strong>\r       <strong>void*</strong>                          <var>address</var><strong>;</strong>\r       <strong>mach_msg_size_t</strong>                   <var>size</var><strong>;</strong>\r       <strong>boolean_t</strong>                   <var>deallocate</var><strong> : 8;</strong>\r       <strong>mach_msg_copy_options_t</strong>           <var>copy</var><strong> : 8;</strong>\r       <strong>unsigned int</strong>                      <var>pad1</var><strong> : 8;</strong>\r       <strong>mach_msg_descriptor_type_t</strong>        <var>type</var><strong> : 8;</strong>\r<strong>} mach_msg_ool_descriptor_t;</strong>\r\r<strong>typedef struct</strong>\r<strong>{</strong>\r       <strong>void*</strong>                           <var>address</var><strong>;</strong>\r       <strong>mach_msg_size_t</strong>                   <var>count</var><strong>;</strong>\r       <strong>boolean_t</strong>                    <var>deallocate</var><strong> : 8;</strong>\r       <strong>mach_msg_copy_options_t</strong>            <var>copy</var><strong> : 8;</strong>\r       <strong>mach_msg_type_name_t</strong>        <var>disposition</var><strong> : 8;</strong>\r       <strong>mach_msg_descriptor_type_t</strong>         <var>type</var><strong> : 8;</strong>\r<strong>} mach_msg_ool_ports_descriptor_t;</strong>\r\r<strong>typedef union</strong>\r<strong>{</strong>\r       <strong>mach_msg_port_descriptor_t</strong>             <var>port</var><strong>;</strong>\r       <strong>mach_msg_ool_descriptor_t</strong>       <var>out_of_line</var><strong>;</strong>\r       <strong>mach_msg_ool_ports_descriptor_t</strong>   <var>ool_ports</var><strong>;</strong>\r       <strong>mach_msg_type_descriptor_t</strong>             <var>type</var><strong>;</strong>\r<strong>} mach_msg_descriptor_t;</strong>\r</pre>\r<h3>FIELDS</h3>\r<dl>\r<dt> <var>name</var>\r<dd>\rFor single port descriptors, the name of the port whose right is being \rsent.\r     <p>\r<dt> <var>disposition</var>\r<dd>\rFor single port or out-of-line port array descriptors, the IPC processing \rto be done for the rights for the named ports.\r     <p>\r<dt> <var>address</var>\r<dd>\rFor out-of-line data or port array descriptors, the address of the \rout-of-line data or port (name) array.\r     <p>\r<dt> <var>size</var>\r<dd>\rFor out-of-line data descriptors, the size of the out-of-line region, in \rbytes.\r     <p>\r<dt> <var>deallocate</var>\r<dd>\rFor out-of-line data descriptors, true if the set of pages containing the \rarray should be de-allocated when the message is sent.\r     <p>\r<dt> <var>copy</var>\r<dd>\rFor out-of-line descriptors, a description of the method by which the \rdata should be copied.\r     <p>\r<dt> <var>count</var>\r<dd>\rFor out-of-line port array descriptors, the number of port names in the \rarray.\r     <p>\r<dt> <var>type</var>\r<dd>\rFor any type of descriptor, the type of descriptor.\r     <p>\r<dt> <var>port</var>\r<dd>\rA descriptor that describes a single port right.\r     <p>\r<dt> <var>out_of_line</var>\r<dd>\rA descriptor that describes an out-of-line data array.\r     <p>\r<dt> <var>ool_ports</var>\r<dd>\rA descriptor that describes an out-of-line port array.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rA <strong>mach_msg_descriptor</strong> structure describes the processing\rto be performed \rfor an element of kernel-processed data in a Mach message.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="mach_msg.html"><strong>mach_msg</strong></a>.\r<p>\rData Structures:\r<a href="mach_msg_header.html"><strong>mach_msg_header</strong></a>.\r