Controller to listen to expired flow removal message
[controller.git] / opendaylight / sal / api / src / main / java / org / opendaylight / controller / sal / flowprogrammer / IPluginOutFlowProgrammerService.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
13 /**
14  * This interface defines the methods the protocol plugin must implement to
15  * inform the SAL layer about the asynchronous messages related to flow
16  * programming coming from the network nodes.
17  */
18 public interface IPluginOutFlowProgrammerService {
19     /**
20      * Inform SAL that the flow on the specified node has been removed Consumer
21      * has to expect this notification only for flows which were installed with
22      * an idle or hard timeout specified.
23      * 
24      * @param node
25      *            the network node on which the flow got removed
26      * @param flow
27      *            the flow that got removed. Note: It may contain only the Match
28      *            and flow parameters fields. Actions may not be present.
29      */
30     public void flowRemoved(Node node, Flow flow);
31 }