read() — netty Function Reference

Architecture documentation for the read() function in FlowControlHandler.java from the netty codebase.

Function java Buffer Allocators calls 1 called by 2

Entity Profile

Buffer→ Allocators→ read() — netty Function Reference

Dependency Diagram

graph TD
  f4d16c7c_e26b_f445_c529_6abbac58ed56["read()"]
  a378d3b4_7977_a8fc_c1dd_b695ec779172["FlowControlHandler"]
  f4d16c7c_e26b_f445_c529_6abbac58ed56 -->|defined in| a378d3b4_7977_a8fc_c1dd_b695ec779172
  ab1fcb76_21ea_cee4_50e0_0d3247fda36a["channelRead()"]
  ab1fcb76_21ea_cee4_50e0_0d3247fda36a -->|calls| f4d16c7c_e26b_f445_c529_6abbac58ed56
  231cc677_f63d_f911_377d_62f5edbedf36["dequeue()"]
  231cc677_f63d_f911_377d_62f5edbedf36 -->|calls| f4d16c7c_e26b_f445_c529_6abbac58ed56
  231cc677_f63d_f911_377d_62f5edbedf36["dequeue()"]
  f4d16c7c_e26b_f445_c529_6abbac58ed56 -->|calls| 231cc677_f63d_f911_377d_62f5edbedf36
  style f4d16c7c_e26b_f445_c529_6abbac58ed56 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

handler/src/main/java/io/netty/handler/flow/FlowControlHandler.java lines 136–147

    @Override
    public void read(ChannelHandlerContext ctx) throws Exception {
        if (dequeue(ctx, 1) == 0) {
            // It seems no messages were consumed. We need to read() some
            // messages from upstream and once one arrives it need to be
            // relayed to downstream to keep the flow going.
            shouldConsume = true;
            ctx.read();
        } else if (config.isAutoRead()) {
            ctx.read();
        }
    }