Packet API changes.
* Renamed 'broadcastPacket' methods to 'broadcastPacketOutEdge'
* Changed parameter order in the 'sendPacket' methods to remain consistent
with the 'broadcastPacketOutEdge' methods, i.e. have the Ethernet packet
as the first parameter
* Added unimplemented notes and exceptions for currently unimplemented methods
Change-Id: I99b14fd8bd34a9a830b301d4a5b6c51e071c0488
diff --git a/src/main/java/net/onrc/onos/api/packet/IPacketService.java b/src/main/java/net/onrc/onos/api/packet/IPacketService.java
index 4321a11..d182c57 100644
--- a/src/main/java/net/onrc/onos/api/packet/IPacketService.java
+++ b/src/main/java/net/onrc/onos/api/packet/IPacketService.java
@@ -28,27 +28,30 @@
// passed around.
/**
* Send a packet out a specific port in the network.
- *
- * @param switchPort the port to send the packet out
* @param eth the packet to send
+ * @param switchPort the port to send the packet out
*/
- public void sendPacket(SwitchPort switchPort, Ethernet eth);
+ public void sendPacket(Ethernet eth, SwitchPort switchPort);
/**
* Send a packet out multiple ports in the network.
+ * <p/>
+ * NOTE: currently unimplemented.
*
- * @param switchPorts a list of ports to send the packet out
* @param eth the packet to send
+ * @param switchPorts a list of ports to send the packet out
*/
- public void sendPacket(List<SwitchPort> switchPorts, Ethernet eth);
+ public void sendPacket(Ethernet eth, List<SwitchPort> switchPorts);
/**
* Broadcast the packet out all edge ports in the network. An edge port is
* defined as any port that doesn't have a link to another switch.
+ * <p/>
+ * NOTE: currently unimplemented.
*
* @param eth the packet to broadcast
*/
- public void broadcastPacket(Ethernet eth);
+ public void broadcastPacketOutEdge(Ethernet eth);
/**
* Broadcast the packet out all edge ports in the network, except for the
@@ -63,5 +66,5 @@
* @param inSwitchPort the exception port that the packet is not
* broadcast out
*/
- public void broadcastPacket(Ethernet eth, SwitchPort inSwitchPort);
+ public void broadcastPacketOutEdge(Ethernet eth, SwitchPort inSwitchPort);
}