opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/flowprogrammer/IFlowProgrammerService.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
   9 package org.opendaylight.controller.sal.flowprogrammer;
  10
  11 import org.opendaylight.controller.sal.core.Node;
  12 import org.opendaylight.controller.sal.utils.Status;
  13
  14 /**
  15  * Interface that defines the methods available to the functional modules above
  16  * SAL for installing/modifying/removing flows on a network node
  17  */
  18 public interface IFlowProgrammerService {
  19     /**
  20      * Synchronously add a flow to the network node
  21      *
  22      * @param node
  23      * @param flow
  24      */
  25     Status addFlow(Node node, Flow flow);
  26
  27     /**
  28      * Synchronously modify existing flow on the switch
  29      *
  30      * @param node
  31      * @param flow
  32      */
  33     Status modifyFlow(Node node, Flow oldFlow, Flow newFlow);
  34
  35     /**
  36      * Synchronously remove the flow from the network node
  37      *
  38      * @param node
  39      * @param flow
  40      */
  41     Status removeFlow(Node node, Flow flow);
  42
  43     /**
  44      * Asynchronously add a flow to the network node
  45      *
  46      * @param node
  47      * @param flow
  48      */
  49     Status addFlowAsync(Node node, Flow flow);
  50
  51     /**
  52      * Asynchronously modify existing flow on the switch
  53      *
  54      * @param node
  55      * @param flow
  56      */
  57     Status modifyFlowAsync(Node node, Flow oldFlow, Flow newFlow);
  58
  59     /**
  60      * Asynchronously remove the flow from the network node
  61      *
  62      * @param node
  63      * @param flow
  64      */
  65     Status removeFlowAsync(Node node, Flow flow);
  66
  67     /**
  68      * Remove all flows present on the network node
  69      *
  70      * @param node
  71      */
  72     Status removeAllFlows(Node node);
  73
  74     /**
  75      * Send synchronous Barrier message
  76      *
  77      * @param node
  78      */
  79     Status sendBarrierMessage(Node node);
  80 }