Home / Class/ IoUringIoEvent Class — netty Architecture

IoUringIoEvent Class — netty Architecture

Architecture documentation for the IoUringIoEvent class in IoUringIoEvent.java from the netty codebase.

Entity Profile

Dependency Diagram

graph TD
  0ca83b6b_6f32_dc5a_6b3c_e56e336f833f["IoUringIoEvent"]
  5e1eeeab_f40a_e1de_16cb_c882c03c7427["IoUringIoEvent.java"]
  0ca83b6b_6f32_dc5a_6b3c_e56e336f833f -->|defined in| 5e1eeeab_f40a_e1de_16cb_c882c03c7427
  93a84319_c68d_79ba_44ac_e652df6136b3["IoUringIoEvent()"]
  0ca83b6b_6f32_dc5a_6b3c_e56e336f833f -->|method| 93a84319_c68d_79ba_44ac_e652df6136b3
  c8ab5e41_0c3b_4bc1_c927_228c783c4c4c["update()"]
  0ca83b6b_6f32_dc5a_6b3c_e56e336f833f -->|method| c8ab5e41_0c3b_4bc1_c927_228c783c4c4c
  eb5848ab_e75a_1d4e_0e42_eedcfa063a3b["res()"]
  0ca83b6b_6f32_dc5a_6b3c_e56e336f833f -->|method| eb5848ab_e75a_1d4e_0e42_eedcfa063a3b
  003d42ac_01c7_de0d_2f01_3cff7ca36a23["flags()"]
  0ca83b6b_6f32_dc5a_6b3c_e56e336f833f -->|method| 003d42ac_01c7_de0d_2f01_3cff7ca36a23
  670dca4f_a0ac_a1c8_0033_682954887f2c["opcode()"]
  0ca83b6b_6f32_dc5a_6b3c_e56e336f833f -->|method| 670dca4f_a0ac_a1c8_0033_682954887f2c
  3c541fed_c3e8_66e9_cc1d_376c99f77569["data()"]
  0ca83b6b_6f32_dc5a_6b3c_e56e336f833f -->|method| 3c541fed_c3e8_66e9_cc1d_376c99f77569
  fe701e35_24b7_f79c_f5de_48ad5804fec2["ByteBuffer()"]
  0ca83b6b_6f32_dc5a_6b3c_e56e336f833f -->|method| fe701e35_24b7_f79c_f5de_48ad5804fec2
  2fac5bc0_b977_34c5_6298_efa66f2006f3["String()"]
  0ca83b6b_6f32_dc5a_6b3c_e56e336f833f -->|method| 2fac5bc0_b977_34c5_6298_efa66f2006f3

Relationship Graph

Source Code

transport-classes-io_uring/src/main/java/io/netty/channel/uring/IoUringIoEvent.java lines 26–114

public final class IoUringIoEvent implements IoEvent {

    private byte opcode;
    private int res;
    private int flags;
    private short data;
    private ByteBuffer extraCqeData;

    /**
     * Create a new instance
     *
     * @param res       the result.
     * @param flags     the flags
     * @param opcode    the op code
     * @param data      the user data that was given as part of the submission.
     */
    public IoUringIoEvent(int res, int flags, byte opcode, short data) {
        this.res = res;
        this.flags = flags;
        this.opcode = opcode;
        this.data = data;
    }

    // Used internally to reduce object creation
    void update(int res, int flags, byte opcode, short data, ByteBuffer extraCqeData) {
        this.res = res;
        this.flags = flags;
        this.opcode = opcode;
        this.data = data;
        this.extraCqeData = extraCqeData;
    }

    /**
     * Returns the result.
     *
     * @return  the result
     */
    public int res() {
        return res;
    }

    /**
     * Returns the flags.
     *
     * @return flags
     */
    public int flags() {
        return flags;
    }

    /**
     * Returns the op code of the {@link IoUringIoOps}.
     *
     * @return  opcode
     */
    public byte opcode() {
        return opcode;
    }

    /**
     * Returns the data that is passed as part of {@link IoUringIoOps}.
     *
     * @return  data.
     */
    public short data() {
        return data;
    }

    /**
     * Returns the extra data for the CQE. This will only be non-null of the ring was setup with
     * {@code IORING_SETUP_CQE32}. As this {@link ByteBuffer} maps into the shared completion queue its important
     * to not hold any reference to it outside of the {@link IoUringIoHandle#handle(IoRegistration, IoEvent)} method.
     *
     * @return extra data for the CQE or {@code null}.
     */
    public ByteBuffer extraCqeData() {
        return extraCqeData;
    }

    @Override
    public String toString() {

Frequently Asked Questions

What is the IoUringIoEvent class?
IoUringIoEvent is a class in the netty codebase, defined in transport-classes-io_uring/src/main/java/io/netty/channel/uring/IoUringIoEvent.java.
Where is IoUringIoEvent defined?
IoUringIoEvent is defined in transport-classes-io_uring/src/main/java/io/netty/channel/uring/IoUringIoEvent.java at line 26.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free