| package net.onrc.onos.core.flowprogrammer; |
| |
| import java.util.Collection; |
| |
| import net.floodlightcontroller.core.internal.OFMessageFuture; |
| import net.floodlightcontroller.core.module.IFloodlightService; |
| import net.onrc.onos.core.intent.FlowEntry; |
| import net.onrc.onos.core.matchaction.MatchActionOperationEntry; |
| import net.onrc.onos.core.util.Dpid; |
| |
| import org.apache.commons.lang3.tuple.Pair; |
| import org.projectfloodlight.openflow.protocol.OFBarrierReply; |
| import org.projectfloodlight.openflow.protocol.OFMessage; |
| |
| /** |
| * FlowPusherService is a service to send message to switches in proper rate. |
| * Conceptually a queue is attached to each switch, and FlowPusherService |
| * read a message from queue and send it to switch in order. |
| * To guarantee message has been installed, FlowPusherService can add barrier |
| * message to queue and can notify when barrier message is sent to switch. |
| */ |
| public interface IFlowPusherService extends IFloodlightService { |
| public static enum MsgPriority { |
| HIGH, // High priority: e.g. flow synchronization |
| NORMAL, // Normal priority |
| // LOW, // Low priority, not needed for now |
| } |
| |
| public static enum QueueState { |
| READY, // Queues with all priority are at work |
| SUSPENDED, // Only prior queue is at work |
| UNKNOWN |
| } |
| |
| /** |
| * Create a queue correspondent to the switch. |
| * |
| * @param dpid DPID of the switch to which new queue is attached. |
| * @return true if new queue is successfully created. |
| */ |
| boolean createQueue(Dpid dpid); |
| |
| /** |
| * Delete a queue correspondent to the switch. |
| * Messages remains in queue will be all sent before queue is deleted. |
| * |
| * @param dpid DPID of the switch from which the queue is deleted. |
| * @return true if queue is successfully deleted. |
| */ |
| boolean deleteQueue(Dpid dpid); |
| |
| /** |
| * Delete a queue correspondent to the switch. |
| * By setting force flag on, queue will be deleted immediately. |
| * |
| * @param dpid DPID of the switch from which the queue is deleted. |
| * @param forceStop If this flag is set to true, queue will be deleted |
| * immediately regardless of any messages in the queue. |
| * If false, all messages will be sent to switch and queue will |
| * be deleted after that. |
| * @return true if queue is successfully deleted or flagged to be deleted. |
| */ |
| boolean deleteQueue(Dpid dpid, boolean forceStop); |
| |
| /** |
| * Add a message to the queue of the switch with normal priority. |
| * <p/> |
| * Note: Notification is NOT delivered for the pushed message. |
| * |
| * @param dpid DPID of the switch to which the message is pushed. |
| * @param msg Message object to be added. |
| * @return true if message is successfully added to a queue. |
| */ |
| boolean add(Dpid dpid, OFMessage msg); |
| |
| /** |
| * Add a message to the queue of the switch with specific priority. |
| * |
| * @param dpid DPID of the switch to which the message is pushed. |
| * @param msg Message object to be added. |
| * @param priority Sending priority of the message. |
| * @return true if message is successfully added to a queue. |
| */ |
| boolean add(Dpid dpid, OFMessage msg, MsgPriority priority); |
| |
| /** |
| * Push a collection of Flow Entries to the corresponding switches |
| * with normal priority. |
| * <p/> |
| * Note: Notification is delivered for the Flow Entries that |
| * are pushed successfully. |
| * |
| * @param entries the collection of <Dpid, FlowEntry> pairs |
| * to push. |
| */ |
| void pushFlowEntries(Collection<Pair<Dpid, FlowEntry>> entries); |
| |
| /** |
| * Push a collection of Flow Entries to the corresponding switches |
| * with specific priority. |
| * <p/> |
| * Note: Notification is delivered for the Flow Entries that |
| * are pushed successfully. |
| * |
| * @param entries the collection of <Dpid, FlowEntry> pairs |
| * to push. |
| * @param priority Sending priority of flow entries. |
| */ |
| void pushFlowEntries(Collection<Pair<Dpid, FlowEntry>> entries, |
| MsgPriority priority); |
| |
| /** |
| * Create a message from FlowEntry and add it to the queue of the |
| * switch with normal priority. |
| * <p/> |
| * Note: Notification is delivered for the Flow Entries that |
| * are pushed successfully. |
| * |
| * @param dpid DPID of the switch to which the message is pushed. |
| * @param flowEntry FlowEntry object used for creating message. |
| */ |
| void pushFlowEntry(Dpid dpid, FlowEntry flowEntry); |
| |
| /** |
| * Create a message from FlowEntry and add it to the queue of the |
| * switch with specific priority. |
| * <p/> |
| * Note: Notification is delivered for the Flow Entries that |
| * are pushed successfully. |
| * |
| * @param dpid DPID of the switch to which the message is pushed. |
| * @param flowEntry FlowEntry object used for creating message. |
| * @param priority Sending priority of flow entries. |
| */ |
| void pushFlowEntry(Dpid dpid, FlowEntry flowEntry, |
| MsgPriority priority); |
| |
| /** |
| * Create a message from MatchAction and add it to the queue of the switch |
| * with normal priority. |
| * |
| * @param matchActionOp MatchAction to use |
| */ |
| void pushMatchAction(MatchActionOperationEntry matchActionOp); |
| |
| /** |
| * Create messages for a collection of MatchActions and add them to the |
| * appropriate queue. |
| * |
| * @param matchActionOps Collection of MatchAction to use |
| */ |
| void pushMatchActions(Collection<MatchActionOperationEntry> matchActionOps); |
| |
| /** |
| * Set sending rate to a switch. |
| * <p/> |
| * TODO The rate limiter function currently does not work as we are unable |
| * to determine the size of the messages when using Loxi. |
| * |
| * @param dpid DPID of the switch to alter the sending rate of. |
| * @param rate Rate in bytes/ms. |
| */ |
| public void setRate(Dpid dpid, long rate); |
| |
| /** |
| * Add BARRIER message to queue and wait for reply. |
| * |
| * @param dpid DPID of the switch to which a barrier message is pushed. |
| * @return BARRIER_REPLY message sent from switch. |
| */ |
| OFBarrierReply barrier(Dpid dpid); |
| |
| /** |
| * Add BARRIER message to queue asynchronously. |
| * |
| * @param dpid DPID of the switch to which a barrier message is pushed. |
| * @return Future object of BARRIER_REPLY message which will be sent from switch. |
| */ |
| OFMessageFuture<OFBarrierReply> barrierAsync(Dpid dpid); |
| |
| /** |
| * Suspend pushing message to a switch. |
| * |
| * @param dpid DPID of the switch whose queue is to be suspended. |
| * @return true if success |
| */ |
| boolean suspend(Dpid dpid); |
| |
| /** |
| * Resume pushing message to a switch. |
| * |
| * @param dpid DPID of the switch whose queue is to be resumed. |
| * @return true if success |
| */ |
| boolean resume(Dpid dpid); |
| |
| /** |
| * Get state of queue attached to a switch. |
| * |
| * @param dpid DPID of the switch to be checked. |
| * @return State of queue. |
| */ |
| QueueState getState(Dpid dpid); |
| } |