Umesh Krishnaswamy | 345ee99 | 2012-12-13 20:29:48 -0800 | [diff] [blame] | 1 | /** |
| 2 | * Copyright (c) 2008 The Board of Trustees of The Leland Stanford Junior |
| 3 | * 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 org.openflow.protocol.factory; |
| 19 | |
| 20 | import java.util.List; |
| 21 | |
| 22 | import org.jboss.netty.buffer.ChannelBuffer; |
| 23 | import org.openflow.protocol.OFMessage; |
| 24 | import org.openflow.protocol.OFType; |
| 25 | |
| 26 | |
| 27 | /** |
| 28 | * The interface to factories used for retrieving OFMessage instances. All |
| 29 | * methods are expected to be thread-safe. |
| 30 | * @author David Erickson (daviderickson@cs.stanford.edu) |
| 31 | */ |
| 32 | public interface OFMessageFactory { |
| 33 | /** |
| 34 | * Retrieves an OFMessage instance corresponding to the specified OFType |
| 35 | * @param t the type of the OFMessage to be retrieved |
| 36 | * @return an OFMessage instance |
| 37 | */ |
| 38 | public OFMessage getMessage(OFType t); |
| 39 | |
| 40 | /** |
| 41 | * Attempts to parse and return a OFMessages contained in the given |
| 42 | * ChannelBuffer, beginning at the ChannelBuffer's position, and ending at the |
| 43 | * after the first parsed message |
| 44 | * @param data the ChannelBuffer to parse for an OpenFlow message |
| 45 | * @return a list of OFMessage instances |
| 46 | * @throws MessageParseException |
| 47 | */ |
| 48 | public List<OFMessage> parseMessage(ChannelBuffer data) throws MessageParseException; |
| 49 | |
| 50 | /** |
| 51 | * Retrieves an OFActionFactory |
| 52 | * @return an OFActionFactory |
| 53 | */ |
| 54 | public OFActionFactory getActionFactory(); |
| 55 | } |