io.netty.handler.codec.haproxy.HAProxyCommand Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of netty-all Show documentation
The newest version!
/*
 * Copyright 2014 The Netty Project
 *
 * The Netty Project licenses this file to you under the Apache License,
 * version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */
package io.netty.handler.codec.haproxy;

/**
 * The command of an HAProxy proxy protocol header
 */
public enum HAProxyCommand {
    /**
     * The LOCAL command represents a connection that was established on purpose by the proxy
     * without being relayed.
     */
    LOCAL(HAProxyConstants.COMMAND_LOCAL_BYTE),
    /**
     * The PROXY command represents a connection that was established on behalf of another node,
     * and reflects the original connection endpoints.
     */
    PROXY(HAProxyConstants.COMMAND_PROXY_BYTE);

    /**
     * The command is specified in the lowest 4 bits of the protocol version and command byte
     */
    private static final byte COMMAND_MASK = 0x0f;

    private final byte byteValue;

    /**
     * Creates a new instance
     */
    HAProxyCommand(byte byteValue) {
        this.byteValue = byteValue;
    }

    /**
     * Returns the {@link HAProxyCommand} represented by the lowest 4 bits of the specified byte.
     *
     * @param verCmdByte protocol version and command byte
     */
    public static HAProxyCommand valueOf(byte verCmdByte) {
        int cmd = verCmdByte & COMMAND_MASK;
        switch ((byte) cmd) {
            case HAProxyConstants.COMMAND_PROXY_BYTE:
                return PROXY;
            case HAProxyConstants.COMMAND_LOCAL_BYTE:
                return LOCAL;
            default:
                throw new IllegalArgumentException("unknown command: " + cmd);
        }
    }

    /**
     * Returns the byte value of this command.
     */
    public byte byteValue() {
        return byteValue;
    }
}