Umesh Krishnaswamy | 345ee99 | 2012-12-13 20:29:48 -0800 | [diff] [blame] | 1 | /** |
| 2 | * Copyright 2011, Big Switch Networks, Inc. |
| 3 | * Originally created by David Erickson, Stanford University |
| 4 | * |
| 5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 6 | * not use this file except in compliance with the License. You may obtain |
| 7 | * a copy of the License at |
| 8 | * |
| 9 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | * |
| 11 | * Unless required by applicable law or agreed to in writing, software |
| 12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 14 | * License for the specific language governing permissions and limitations |
| 15 | * under the License. |
| 16 | **/ |
| 17 | |
| 18 | package net.floodlightcontroller.core; |
| 19 | |
| 20 | /** |
| 21 | * Used in conjunction with {@link IOFMessageListener} to allow a listener to |
| 22 | * filter an incoming message based on the {@link IOFSwitch} it originated from. |
| 23 | * Implementations wanting to use this interface should implement both |
| 24 | * IOFMessageListener and IOFSwitchFilter. |
| 25 | * |
| 26 | * @author David Erickson (daviderickson@cs.stanford.edu) |
| 27 | */ |
| 28 | public interface IOFSwitchFilter { |
| 29 | |
| 30 | /** |
| 31 | * The result of this method call determines whether the |
| 32 | * IOFMessageListener's receive method is called or not. |
| 33 | * |
| 34 | * @param sw switch to filter on |
| 35 | * @return true to receive the message, false to ignore |
| 36 | */ |
| 37 | public boolean isInterested(IOFSwitch sw); |
| 38 | } |