Home / Class/ Socks5CommandRequestDecoder Class — netty Architecture

Socks5CommandRequestDecoder Class — netty Architecture

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

Entity Profile

Dependency Diagram

graph TD
  e8e9c6d8_866c_2c7f_bad6_de6efe9ff434["Socks5CommandRequestDecoder"]
  97d67ede_d25f_381b_933a_588d9236de5a["Socks5CommandRequestDecoder.java"]
  e8e9c6d8_866c_2c7f_bad6_de6efe9ff434 -->|defined in| 97d67ede_d25f_381b_933a_588d9236de5a
  cbf5793e_1392_13e4_f490_fba312693efd["Socks5CommandRequestDecoder()"]
  e8e9c6d8_866c_2c7f_bad6_de6efe9ff434 -->|method| cbf5793e_1392_13e4_f490_fba312693efd
  a7f50bee_53d6_ab01_d695_13dc24d8f39f["decode()"]
  e8e9c6d8_866c_2c7f_bad6_de6efe9ff434 -->|method| a7f50bee_53d6_ab01_d695_13dc24d8f39f
  fb00be81_3365_e361_899e_856ea8cfc811["fail()"]
  e8e9c6d8_866c_2c7f_bad6_de6efe9ff434 -->|method| fb00be81_3365_e361_899e_856ea8cfc811

Relationship Graph

Source Code

codec-socks/src/main/java/io/netty/handler/codec/socksx/v5/Socks5CommandRequestDecoder.java lines 38–107

public class Socks5CommandRequestDecoder extends ReplayingDecoder<State> {

    @UnstableApi
    public enum State {
        INIT,
        SUCCESS,
        FAILURE
    }

    private final Socks5AddressDecoder addressDecoder;

    public Socks5CommandRequestDecoder() {
        this(Socks5AddressDecoder.DEFAULT);
    }

    public Socks5CommandRequestDecoder(Socks5AddressDecoder addressDecoder) {
        super(State.INIT);
        this.addressDecoder = ObjectUtil.checkNotNull(addressDecoder, "addressDecoder");
    }

    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
        try {
            switch (state()) {
            case INIT: {
                final byte version = in.readByte();
                if (version != SocksVersion.SOCKS5.byteValue()) {
                    throw new DecoderException(
                            "unsupported version: " + version + " (expected: " + SocksVersion.SOCKS5.byteValue() + ')');
                }

                final Socks5CommandType type = Socks5CommandType.valueOf(in.readByte());
                in.skipBytes(1); // RSV
                final Socks5AddressType dstAddrType = Socks5AddressType.valueOf(in.readByte());
                final String dstAddr = addressDecoder.decodeAddress(dstAddrType, in);
                final int dstPort = ByteBufUtil.readUnsignedShortBE(in);

                out.add(new DefaultSocks5CommandRequest(type, dstAddrType, dstAddr, dstPort));
                checkpoint(State.SUCCESS);
            }
            case SUCCESS: {
                int readableBytes = actualReadableBytes();
                if (readableBytes > 0) {
                    out.add(in.readRetainedSlice(readableBytes));
                }
                break;
            }
            case FAILURE: {
                in.skipBytes(actualReadableBytes());
                break;
            }
            }
        } catch (Exception e) {
            fail(out, e);
        }
    }

    private void fail(List<Object> out, Exception cause) {
        if (!(cause instanceof DecoderException)) {
            cause = new DecoderException(cause);
        }

        checkpoint(State.FAILURE);

        Socks5Message m = new DefaultSocks5CommandRequest(
                Socks5CommandType.CONNECT, Socks5AddressType.IPv4, "0.0.0.0", 1);
        m.setDecoderResult(DecoderResult.failure(cause));
        out.add(m);
    }
}

Frequently Asked Questions

What is the Socks5CommandRequestDecoder class?
Socks5CommandRequestDecoder is a class in the netty codebase, defined in codec-socks/src/main/java/io/netty/handler/codec/socksx/v5/Socks5CommandRequestDecoder.java.
Where is Socks5CommandRequestDecoder defined?
Socks5CommandRequestDecoder is defined in codec-socks/src/main/java/io/netty/handler/codec/socksx/v5/Socks5CommandRequestDecoder.java at line 38.

Analyze Your Own Codebase

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

Try Supermodel Free