/*
 * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */

package org.opendaylight.openflowjava.protocol.api.util;

/**
 * Stores common constants.
 * @author michal.polkorab
 */
public abstract class EncodeConstants {

    /** Default OF padding (in bytes) */
    public static final byte PADDING = 8;
    /** OpenFlow v1.0 wire protocol number */
    public static final byte OF10_VERSION_ID = 0x01;
    /** OpenFlow v1.3 wire protocol number */
    public static final byte OF13_VERSION_ID = 0x04;
    /** OpenFlow v1.4 wire protocol number */
    public static final byte OF14_VERSION_ID = 0x05;
    /** OpenFlow v1.5 wire protocol number */
    public static final byte OF15_VERSION_ID = 0x06;
    /** OpenFlow Hello message type value */
    public static final byte OF_HELLO_MESSAGE_TYPE_VALUE = 0;
    /** OpenFlow PacketIn message type value */
    public static final byte OF_PACKETIN_MESSAGE_TYPE_VALUE = 10;
    /** Index of length in Openflow header */
    public static final int OFHEADER_LENGTH_INDEX = 2;
    /** Size of Openflow header */
    public static final int OFHEADER_SIZE = 8;
    /** Zero length - used when the length is updated later */
    public static final int EMPTY_LENGTH = 0;

    /** Length of mac address */
    public static final byte MAC_ADDRESS_LENGTH = 6;
    /** Number of groups in ipv4 address */
    public static final byte GROUPS_IN_IPV4_ADDRESS = 4;
    /** Number of groups in ipv6 address */
    public static final byte GROUPS_IN_IPV6_ADDRESS = 8;
    /** Length of ipv6 address in bytes */
    public static final byte SIZE_OF_IPV6_ADDRESS_IN_BYTES = (8 * Short.SIZE) / Byte.SIZE;

    /** Length of long in bytes */
    public static final byte SIZE_OF_LONG_IN_BYTES = Long.SIZE / Byte.SIZE;
    /** Length of int in bytes */
    public static final byte SIZE_OF_INT_IN_BYTES = Integer.SIZE / Byte.SIZE;
    /** Length of short in bytes */
    public static final byte SIZE_OF_SHORT_IN_BYTES = Short.SIZE / Byte.SIZE;
    /** Length of byte in bytes */
    public static final byte SIZE_OF_BYTE_IN_BYTES = Byte.SIZE / Byte.SIZE;
    /** Length of 3 bytes */
    public static final byte SIZE_OF_3_BYTES = 3;

    /** Empty (zero) int value */
    public static final int EMPTY_VALUE = 0;
    /** Common experimenter value */
    public static final int EXPERIMENTER_VALUE = 0xFFFF;

    /** OF v1.0 maximal port name length */
    public static final byte MAX_PORT_NAME_LENGTH = 16;

    /** ONF Approved Extensions Constants */
    /** Experimenter ID of ONF approved extensions */
    public static final long ONF_EXPERIMENTER_ID = 0x4F4E4600;
    /** ONFOXM_ET_TCP_FLAGS value */
    public static final int ONFOXM_ET_TCP_FLAGS = 42;

    private EncodeConstants() {
        //not called
    }
}