Home / Class/ WebSocketFrameHandler Class — netty Architecture

WebSocketFrameHandler Class — netty Architecture

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

Entity Profile

Dependency Diagram

graph TD
  009d4a05_460c_38db_f8c2_4f86c852162c["WebSocketFrameHandler"]
  4bef85cf_fa61_6a46_5059_13372789bf57["WebSocketFrameHandler.java"]
  009d4a05_460c_38db_f8c2_4f86c852162c -->|defined in| 4bef85cf_fa61_6a46_5059_13372789bf57
  75dd4498_92e9_299c_8cbd_96979ba3d8df["channelRead0()"]
  009d4a05_460c_38db_f8c2_4f86c852162c -->|method| 75dd4498_92e9_299c_8cbd_96979ba3d8df
  42f66645_fd84_2315_920d_529cf18e9bb9["userEventTriggered()"]
  009d4a05_460c_38db_f8c2_4f86c852162c -->|method| 42f66645_fd84_2315_920d_529cf18e9bb9

Relationship Graph

Source Code

example/src/main/java/io/netty/example/http/websocketx/server/WebSocketFrameHandler.java lines 29–54

public class WebSocketFrameHandler extends SimpleChannelInboundHandler<WebSocketFrame> {

    @Override
    protected void channelRead0(ChannelHandlerContext ctx, WebSocketFrame frame) throws Exception {
        // ping and pong frames already handled

        if (frame instanceof TextWebSocketFrame) {
            // Send the uppercase string back.
            String request = ((TextWebSocketFrame) frame).text();
            ctx.channel().writeAndFlush(new TextWebSocketFrame(request.toUpperCase(Locale.US)));
        } else {
            String message = "unsupported frame type: " + frame.getClass().getName();
            throw new UnsupportedOperationException(message);
        }
    }

    @Override
    public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
        if (evt instanceof WebSocketServerProtocolHandler.HandshakeComplete) {
            //Channel upgrade to websocket, remove WebSocketIndexPageHandler.
            ctx.pipeline().remove(WebSocketIndexPageHandler.class);
        } else {
            super.userEventTriggered(ctx, evt);
        }
    }
}

Frequently Asked Questions

What is the WebSocketFrameHandler class?
WebSocketFrameHandler is a class in the netty codebase, defined in example/src/main/java/io/netty/example/http/websocketx/server/WebSocketFrameHandler.java.
Where is WebSocketFrameHandler defined?
WebSocketFrameHandler is defined in example/src/main/java/io/netty/example/http/websocketx/server/WebSocketFrameHandler.java at line 29.

Analyze Your Own Codebase

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

Try Supermodel Free