opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/flowprogrammer/IPluginInFlowProgrammerService.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  * @file IPluginOutFlowProgrammer.java
  16  *
  17  * @brief Flow programmer interface to be implemented by protocol plugins
  18  */
  19 public interface IPluginInFlowProgrammerService {
  20     /**
  21      * Synchronously add a flow to the network node
  22      *
  23      * @param node
  24      * @param flow
  25      */
  26     Status addFlow(Node node, Flow flow);
  27
  28     /**
  29      * Synchronously modify existing flow on the switch
  30      *
  31      * @param node
  32      * @param flow
  33      */
  34     Status modifyFlow(Node node, Flow oldFlow, Flow newFlow);
  35
  36     /**
  37      * Synchronously remove the flow from the network node
  38      *
  39      * @param node
  40      * @param flow
  41      */
  42     Status removeFlow(Node node, Flow flow);
  43
  44     /**
  45      * Asynchronously add a flow to the network node
  46      *
  47      * @param node
  48      * @param flow
  49      * @param rid
  50      */
  51     Status addFlowAsync(Node node, Flow flow, long rid);
  52
  53     /**
  54      * Asynchronously modify existing flow on the switch
  55      *
  56      * @param node
  57      * @param flow
  58      * @param rid
  59      */
  60     Status modifyFlowAsync(Node node, Flow oldFlow, Flow newFlow, long rid);
  61
  62     /**
  63      * Asynchronously remove the flow from the network node
  64      *
  65      * @param node
  66      * @param flow
  67      * @param rid
  68      */
  69     Status removeFlowAsync(Node node, Flow flow, long rid);
  70
  71     /**
  72      * Remove all flows present on the network node
  73      *
  74      * @param node
  75      */
  76     Status removeAllFlows(Node node);
  77
  78     /**
  79      * Send synchronous Barrier message
  80      *
  81      * @param node
  82      */
  83     Status sendBarrierMessage(Node node);
  84 }