readIfNeeded() — netty Function Reference

Architecture documentation for the readIfNeeded() function in SslHandler.java from the netty codebase.

Function java Buffer Allocators calls 2 called by 3

Entity Profile

Buffer→ Allocators→ readIfNeeded() — netty Function Reference

Dependency Diagram

graph TD
  37fdca52_5a27_1da0_971b_e56a22cd3521["readIfNeeded()"]
  d8b07a7c_44f8_c4e9_efe8_49bfae7d4af1["SslHandler"]
  37fdca52_5a27_1da0_971b_e56a22cd3521 -->|defined in| d8b07a7c_44f8_c4e9_efe8_49bfae7d4af1
  ca3c58ac_45a7_24e9_d74b_140cea69627e["wrap()"]
  ca3c58ac_45a7_24e9_d74b_140cea69627e -->|calls| 37fdca52_5a27_1da0_971b_e56a22cd3521
  377b07e2_f49b_043e_067e_6dc91938e4d9["channelReadComplete0()"]
  377b07e2_f49b_043e_067e_6dc91938e4d9 -->|calls| 37fdca52_5a27_1da0_971b_e56a22cd3521
  51b61e7d_0f6d_53c7_ed6a_56a55b2ed5a7["unwrap()"]
  51b61e7d_0f6d_53c7_ed6a_56a55b2ed5a7 -->|calls| 37fdca52_5a27_1da0_971b_e56a22cd3521
  52f75d24_7c2b_f055_d7e7_b2cfcc304a7f["isStateSet()"]
  37fdca52_5a27_1da0_971b_e56a22cd3521 -->|calls| 52f75d24_7c2b_f055_d7e7_b2cfcc304a7f
  83a0158f_b432_6f94_08e9_4ba1d7ed442a["read()"]
  37fdca52_5a27_1da0_971b_e56a22cd3521 -->|calls| 83a0158f_b432_6f94_08e9_4ba1d7ed442a
  style 37fdca52_5a27_1da0_971b_e56a22cd3521 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

handler/src/main/java/io/netty/handler/ssl/SslHandler.java lines 1466–1474

    private void readIfNeeded(ChannelHandlerContext ctx) {
        // If handshake is not finished yet, we need more data.
        if (!ctx.channel().config().isAutoRead() &&
                (!isStateSet(STATE_FIRE_CHANNEL_READ) || !handshakePromise.isDone())) {
            // No auto-read used and no message passed through the ChannelPipeline or the handshake was not complete
            // yet, which means we need to trigger the read to ensure we not encounter any stalls.
            ctx.read();
        }
    }