openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/OFConstants.java

   1 /**
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.openflowplugin.api;
   9
  10 import java.math.BigInteger;
  11 import org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.FlowCookie;
  12
  13 /**
  14  * OFP related constants
  15  */
  16 public final class OFConstants {
  17
  18     private OFConstants() {
  19         throw new UnsupportedOperationException("OF plugin Constants holder class");
  20     }
  21
  22     /** enum ofp_port_no, reserved port: process with normal L2/L3 switching  */
  23     public static final short OFPP_NORMAL = ((short)0xfffa);
  24     /** enum ofp_port_no, reserved port: all physical ports except input port  */
  25     public static final short OFPP_ALL  = ((short)0xfffc);
  26     /** enum ofp_port_no, reserved port: local openflow port  */
  27     public static final short OFPP_LOCAL = ((short)0xfffe);
  28
  29
  30     /** openflow protocol 1.0 - version identifier */
  31     public static final short OFP_VERSION_1_0 = 0x01;
  32     /** openflow protocol 1.3 - version identifier */
  33     public static final short OFP_VERSION_1_3 = 0x04;
  34
  35     public final static String OF_URI_PREFIX = "openflow:";
  36
  37     /** enum ofp_table: Table numbering, wildcard table used for table config, flow stats and flow deletes. */
  38     public static final Short OFPTT_ALL = 0xff;
  39     public static final Long ANY = 0xffffffffL;
  40     /** Wildcard port used only for flow mod (delete) and flow stats requests. Selects
  41      *  all flows regardless of output port (including flows with no output port).*/
  42     public static final Long OFPP_ANY = ANY;
  43     /** enum ofp_group: For OFPFC_DELETE* commands, require matching entries to include this as an
  44      *  output group. A value of OFPG_ANY indicates no restriction. */
  45     public static final Long OFPG_ANY = ANY;
  46     /** enum ofp_group: Represents all groups for group delete commands. */
  47     public static final Long OFPG_ALL = 0xfffffffcL;
  48     /** Refers to all queues conﬁgured at the speciﬁed port. */
  49     public static final Long OFPQ_ALL = ANY;
  50     /** default cookie */
  51     public static final BigInteger DEFAULT_COOKIE = BigInteger.ZERO;
  52     public static final BigInteger DEFAULT_COOKIE_MASK = BigInteger.ZERO;
  53     public static final FlowCookie DEFAULT_FLOW_COOKIE = new FlowCookie(DEFAULT_COOKIE);
  54     /** indicates that no buffering should be applied and the whole packet is to be
  55      *  sent to the controller. */
  56     public static final Long OFP_NO_BUFFER = 0xffffffffL;
  57     /** enum ofp_controller_max_len: indicates that no buffering should be applied and the whole packet is to be
  58      *  sent to the controller. */
  59     public static final Integer OFPCML_NO_BUFFER = 0xffff;
  60
  61
  62     public static final int MAC_ADDRESS_LENGTH = 6;
  63     public static final int SIZE_OF_LONG_IN_BYTES = 8;
  64     public static final int SIGNUM_UNSIGNED = 1;
  65
  66     /** RpcError application tag */
  67     public static final String APPLICATION_TAG = "OPENFLOW_PLUGIN";
  68     /** RpcError tag - timeout */
  69     public static final String ERROR_TAG_TIMEOUT = "TIMOUT";
  70 }