| <link rel="stylesheet" href="../style.css" /> |
| |
| [TOC] |
| # zx |
| |
| <p><b>Added:7</b></p> |
| |
| |
| |
| ## **ENUMS** |
| |
| ### obj_type [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#obj_type data-text="obj_type"} |
| Type: <code>uint32</code> |
| |
| *Defined in [zx/zx_common.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=59)* |
| |
| <table> |
| <tr><th>Name</th><th>Value</th><th>Description</th></tr> |
| <tr id="obj_type.NONE"> |
| <td><h3 id="obj_type.NONE" class="add-link hide-from-toc">NONE</h3></td> |
| <td><code>0</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.PROCESS"> |
| <td><h3 id="obj_type.PROCESS" class="add-link hide-from-toc">PROCESS</h3></td> |
| <td><code>1</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.THREAD"> |
| <td><h3 id="obj_type.THREAD" class="add-link hide-from-toc">THREAD</h3></td> |
| <td><code>2</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.VMO"> |
| <td><h3 id="obj_type.VMO" class="add-link hide-from-toc">VMO</h3></td> |
| <td><code>3</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.CHANNEL"> |
| <td><h3 id="obj_type.CHANNEL" class="add-link hide-from-toc">CHANNEL</h3></td> |
| <td><code>4</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.EVENT"> |
| <td><h3 id="obj_type.EVENT" class="add-link hide-from-toc">EVENT</h3></td> |
| <td><code>5</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.PORT"> |
| <td><h3 id="obj_type.PORT" class="add-link hide-from-toc">PORT</h3></td> |
| <td><code>6</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.INTERRUPT"> |
| <td><h3 id="obj_type.INTERRUPT" class="add-link hide-from-toc">INTERRUPT</h3></td> |
| <td><code>9</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.PCI_DEVICE"> |
| <td><h3 id="obj_type.PCI_DEVICE" class="add-link hide-from-toc">PCI_DEVICE</h3></td> |
| <td><code>11</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.LOG"> |
| <td><h3 id="obj_type.LOG" class="add-link hide-from-toc">LOG</h3></td> |
| <td><code>12</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.SOCKET"> |
| <td><h3 id="obj_type.SOCKET" class="add-link hide-from-toc">SOCKET</h3></td> |
| <td><code>14</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.RESOURCE"> |
| <td><h3 id="obj_type.RESOURCE" class="add-link hide-from-toc">RESOURCE</h3></td> |
| <td><code>15</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.EVENTPAIR"> |
| <td><h3 id="obj_type.EVENTPAIR" class="add-link hide-from-toc">EVENTPAIR</h3></td> |
| <td><code>16</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.JOB"> |
| <td><h3 id="obj_type.JOB" class="add-link hide-from-toc">JOB</h3></td> |
| <td><code>17</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.VMAR"> |
| <td><h3 id="obj_type.VMAR" class="add-link hide-from-toc">VMAR</h3></td> |
| <td><code>18</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.FIFO"> |
| <td><h3 id="obj_type.FIFO" class="add-link hide-from-toc">FIFO</h3></td> |
| <td><code>19</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.GUEST"> |
| <td><h3 id="obj_type.GUEST" class="add-link hide-from-toc">GUEST</h3></td> |
| <td><code>20</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.VCPU"> |
| <td><h3 id="obj_type.VCPU" class="add-link hide-from-toc">VCPU</h3></td> |
| <td><code>21</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.TIMER"> |
| <td><h3 id="obj_type.TIMER" class="add-link hide-from-toc">TIMER</h3></td> |
| <td><code>22</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.IOMMU"> |
| <td><h3 id="obj_type.IOMMU" class="add-link hide-from-toc">IOMMU</h3></td> |
| <td><code>23</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.BTI"> |
| <td><h3 id="obj_type.BTI" class="add-link hide-from-toc">BTI</h3></td> |
| <td><code>24</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.PROFILE"> |
| <td><h3 id="obj_type.PROFILE" class="add-link hide-from-toc">PROFILE</h3></td> |
| <td><code>25</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.PMT"> |
| <td><h3 id="obj_type.PMT" class="add-link hide-from-toc">PMT</h3></td> |
| <td><code>26</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.SUSPEND_TOKEN"> |
| <td><h3 id="obj_type.SUSPEND_TOKEN" class="add-link hide-from-toc">SUSPEND_TOKEN</h3></td> |
| <td><code>27</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.PAGER"> |
| <td><h3 id="obj_type.PAGER" class="add-link hide-from-toc">PAGER</h3></td> |
| <td><code>28</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.EXCEPTION"> |
| <td><h3 id="obj_type.EXCEPTION" class="add-link hide-from-toc">EXCEPTION</h3></td> |
| <td><code>29</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.CLOCK"> |
| <td><h3 id="obj_type.CLOCK" class="add-link hide-from-toc">CLOCK</h3></td> |
| <td><code>30</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.STREAM"> |
| <td><h3 id="obj_type.STREAM" class="add-link hide-from-toc">STREAM</h3></td> |
| <td><code>31</code></td> |
| <td></td> |
| </tr> |
| <tr id="obj_type.MSI"> |
| <td><h3 id="obj_type.MSI" class="add-link hide-from-toc">MSI</h3></td> |
| <td><code>32</code></td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| |
| |
| ## **BITS** |
| |
| ### rights [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#rights} |
| Type: <code>uint32</code> |
| |
| *Defined in [zx/rights.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/rights.fidl;l=7)* |
| |
| <table> |
| <tr><th>Name</th><th>Value</th><th>Description</th></tr> |
| <tr id="rights.DUPLICATE"> |
| <td><h3 id="rights.DUPLICATE" class="add-link hide-from-toc">DUPLICATE</h3></td> |
| <td>1</td> |
| <td></td> |
| </tr> |
| <tr id="rights.TRANSFER"> |
| <td><h3 id="rights.TRANSFER" class="add-link hide-from-toc">TRANSFER</h3></td> |
| <td>2</td> |
| <td></td> |
| </tr> |
| <tr id="rights.READ"> |
| <td><h3 id="rights.READ" class="add-link hide-from-toc">READ</h3></td> |
| <td>4</td> |
| <td></td> |
| </tr> |
| <tr id="rights.WRITE"> |
| <td><h3 id="rights.WRITE" class="add-link hide-from-toc">WRITE</h3></td> |
| <td>8</td> |
| <td></td> |
| </tr> |
| <tr id="rights.EXECUTE"> |
| <td><h3 id="rights.EXECUTE" class="add-link hide-from-toc">EXECUTE</h3></td> |
| <td>16</td> |
| <td></td> |
| </tr> |
| <tr id="rights.MAP"> |
| <td><h3 id="rights.MAP" class="add-link hide-from-toc">MAP</h3></td> |
| <td>32</td> |
| <td></td> |
| </tr> |
| <tr id="rights.GET_PROPERTY"> |
| <td><h3 id="rights.GET_PROPERTY" class="add-link hide-from-toc">GET_PROPERTY</h3></td> |
| <td>64</td> |
| <td></td> |
| </tr> |
| <tr id="rights.SET_PROPERTY"> |
| <td><h3 id="rights.SET_PROPERTY" class="add-link hide-from-toc">SET_PROPERTY</h3></td> |
| <td>128</td> |
| <td></td> |
| </tr> |
| <tr id="rights.ENUMERATE"> |
| <td><h3 id="rights.ENUMERATE" class="add-link hide-from-toc">ENUMERATE</h3></td> |
| <td>256</td> |
| <td></td> |
| </tr> |
| <tr id="rights.DESTROY"> |
| <td><h3 id="rights.DESTROY" class="add-link hide-from-toc">DESTROY</h3></td> |
| <td>512</td> |
| <td></td> |
| </tr> |
| <tr id="rights.SET_POLICY"> |
| <td><h3 id="rights.SET_POLICY" class="add-link hide-from-toc">SET_POLICY</h3></td> |
| <td>1024</td> |
| <td></td> |
| </tr> |
| <tr id="rights.GET_POLICY"> |
| <td><h3 id="rights.GET_POLICY" class="add-link hide-from-toc">GET_POLICY</h3></td> |
| <td>2048</td> |
| <td></td> |
| </tr> |
| <tr id="rights.SIGNAL"> |
| <td><h3 id="rights.SIGNAL" class="add-link hide-from-toc">SIGNAL</h3></td> |
| <td>4096</td> |
| <td></td> |
| </tr> |
| <tr id="rights.SIGNAL_PEER"> |
| <td><h3 id="rights.SIGNAL_PEER" class="add-link hide-from-toc">SIGNAL_PEER</h3></td> |
| <td>8192</td> |
| <td></td> |
| </tr> |
| <tr id="rights.WAIT"> |
| <td><h3 id="rights.WAIT" class="add-link hide-from-toc">WAIT</h3></td> |
| <td>16384</td> |
| <td></td> |
| </tr> |
| <tr id="rights.INSPECT"> |
| <td><h3 id="rights.INSPECT" class="add-link hide-from-toc">INSPECT</h3></td> |
| <td>32768</td> |
| <td></td> |
| </tr> |
| <tr id="rights.MANAGE_JOB"> |
| <td><h3 id="rights.MANAGE_JOB" class="add-link hide-from-toc">MANAGE_JOB</h3></td> |
| <td>65536</td> |
| <td></td> |
| </tr> |
| <tr id="rights.MANAGE_PROCESS"> |
| <td><h3 id="rights.MANAGE_PROCESS" class="add-link hide-from-toc">MANAGE_PROCESS</h3></td> |
| <td>131072</td> |
| <td></td> |
| </tr> |
| <tr id="rights.MANAGE_THREAD"> |
| <td><h3 id="rights.MANAGE_THREAD" class="add-link hide-from-toc">MANAGE_THREAD</h3></td> |
| <td>262144</td> |
| <td></td> |
| </tr> |
| <tr id="rights.APPLY_PROFILE"> |
| <td><h3 id="rights.APPLY_PROFILE" class="add-link hide-from-toc">APPLY_PROFILE</h3></td> |
| <td>524288</td> |
| <td></td> |
| </tr> |
| <tr id="rights.MANAGE_SOCKET"> |
| <td><h3 id="rights.MANAGE_SOCKET" class="add-link hide-from-toc">MANAGE_SOCKET</h3></td> |
| <td>1048576</td> |
| <td></td> |
| </tr> |
| <tr id="rights.SAME_RIGHTS"> |
| <td><h3 id="rights.SAME_RIGHTS" class="add-link hide-from-toc">SAME_RIGHTS</h3></td> |
| <td>2147483648</td> |
| <td></td> |
| </tr> |
| </table> |
| |
| |
| ## **CONSTANTS** |
| |
| <table> |
| <tr><th>Name</th><th>Value</th><th>Type</th><th>Description</th></tr> |
| <tr id="CHANNEL_MAX_MSG_BYTES"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=54">CHANNEL_MAX_MSG_BYTES</a></td> |
| <td> |
| <code>65536</code> |
| </td> |
| <td><code>uint64</code></td> |
| <td></td> |
| </tr> |
| <tr id="CHANNEL_MAX_MSG_HANDLES"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=55">CHANNEL_MAX_MSG_HANDLES</a></td> |
| <td> |
| <code>64</code> |
| </td> |
| <td><code>uint64</code></td> |
| <td></td> |
| </tr> |
| <tr id="DEFAULT_CHANNEL_RIGHTS"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/rights.fidl;l=39">DEFAULT_CHANNEL_RIGHTS</a></td> |
| <td></td> |
| </tr> |
| <tr id="DEFAULT_EVENT_RIGHTS"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/rights.fidl;l=41">DEFAULT_EVENT_RIGHTS</a></td> |
| <td></td> |
| </tr> |
| <tr id="MAX_CPUS"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=57">MAX_CPUS</a></td> |
| <td> |
| <code>512</code> |
| </td> |
| <td><code>uint64</code></td> |
| <td></td> |
| </tr> |
| <tr id="MAX_NAME_LEN"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=56">MAX_NAME_LEN</a></td> |
| <td> |
| <code>32</code> |
| </td> |
| <td><code>uint64</code></td> |
| <td></td> |
| </tr> |
| <tr id="RIGHTS_BASIC"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/rights.fidl;l=34">RIGHTS_BASIC</a></td> |
| <td></td> |
| </tr> |
| <tr id="RIGHTS_IO"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/rights.fidl;l=35">RIGHTS_IO</a></td> |
| <td></td> |
| </tr> |
| <tr id="RIGHTS_POLICY"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/rights.fidl;l=37">RIGHTS_POLICY</a></td> |
| <td></td> |
| </tr> |
| <tr id="RIGHTS_PROPERTY"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/rights.fidl;l=36">RIGHTS_PROPERTY</a></td> |
| <td></td> |
| </tr> |
| </table> |
| |
| ## **TYPE ALIASES** |
| |
| <table> |
| <tr><th>Name</th><th>Value</th><th>Description</th></tr> |
| <tr id="duration"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=22">duration</a></td> |
| <td> |
| <code>int64</code></td> |
| <td></td> |
| </tr> |
| <tr id="gpaddr"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=40">gpaddr</a></td> |
| <td> |
| <code>uint64</code></td> |
| <td></td> |
| </tr> |
| <tr id="koid"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=28">koid</a></td> |
| <td> |
| <code>uint64</code></td> |
| <td></td> |
| </tr> |
| <tr id="off"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=43">off</a></td> |
| <td> |
| <code>uint64</code></td> |
| <td></td> |
| </tr> |
| <tr id="paddr"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=34">paddr</a></td> |
| <td> |
| <code>uint64</code></td> |
| <td></td> |
| </tr> |
| <tr id="paddr32"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=37">paddr32</a></td> |
| <td> |
| <code>uint32</code></td> |
| <td></td> |
| </tr> |
| <tr id="procarg"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=46">procarg</a></td> |
| <td> |
| <code>uint32</code></td> |
| <td></td> |
| </tr> |
| <tr id="signals"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=49">signals</a></td> |
| <td> |
| <code>uint32</code></td> |
| <td></td> |
| </tr> |
| <tr id="status"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=15">status</a></td> |
| <td> |
| <code>int32</code></td> |
| <td></td> |
| </tr> |
| <tr id="ticks"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=25">ticks</a></td> |
| <td> |
| <code>int64</code></td> |
| <td></td> |
| </tr> |
| <tr id="time"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=19">time</a></td> |
| <td> |
| <code>int64</code></td> |
| <td></td> |
| </tr> |
| <tr id="vaddr"> |
| <td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:zircon/vdso/zx_common.fidl;l=31">vaddr</a></td> |
| <td> |
| <code>uint64</code></td> |
| <td></td> |
| </tr> |
| </table> |