fixed the LINC-OE behaviour. Handshaker behaviours must use

sendHandshakeMessage during the handshake rather than sendMsg.

Change-Id: I50b3da2c592f77dd786da68d42e5dc289407cd37

@@ -45,7 +45,7 @@ public class DefaultSwitchHandShaker extends AbstractOpenFlowSwitch {
         if (factory().getVersion() == OFVersion.OF_10) {
         if (factory().getVersion() == OFVersion.OF_10) {
             OFFlowAdd.Builder fmBuilder = factory().buildFlowAdd();
             OFFlowAdd.Builder fmBuilder = factory().buildFlowAdd();
             fmBuilder.setPriority(LOWEST_PRIORITY);
             fmBuilder.setPriority(LOWEST_PRIORITY);
-            sendMsg(fmBuilder.build());
+            sendHandshakeMessage(fmBuilder.build());
         }
         }
     }
     }
 
 

@@ -64,7 +64,7 @@ public class OFCorsaSwitchDriver extends AbstractOpenFlowSwitch {
                 .setXid(barrierXid).build();
                 .setXid(barrierXid).build();
 
 
 
 
-        sendMsg(Collections.singletonList(barrier));
+        sendHandshakeMessage(barrier);
 
 
     }
     }
 
 

@@ -64,9 +64,6 @@ public class OFOpticalSwitchImplLINC13 extends AbstractOpenFlowSwitch {
 
 
     @Override
     @Override
     public boolean isDriverHandshakeComplete() {
     public boolean isDriverHandshakeComplete() {
-        if (!startDriverHandshakeCalled) {
-            throw new SwitchDriverSubHandshakeNotStarted();
-        }
         return driverHandshakeComplete.get();
         return driverHandshakeComplete.get();
     }
     }
 
 
@@ -161,7 +158,7 @@ public class OFOpticalSwitchImplLINC13 extends AbstractOpenFlowSwitch {
                          "message " +
                          "message " +
                          "{}",
                          "{}",
                  circuitPortsRequest.toString());
                  circuitPortsRequest.toString());
-        this.sendMsg(Collections.<OFMessage>singletonList(circuitPortsRequest));
+        this.sendHandshakeMessage(circuitPortsRequest);
     }
     }
 
 
     @Override
     @Override

@@ -222,7 +222,7 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                 .build();
                 .build();
         msglist.add(getAC);
         msglist.add(getAC);
 
 
-        sendMsg(msglist);
+        msglist.stream().forEach(m -> sendHandshakeMessage(m));
     }
     }
 
 
     private void decodeAsyncGetReply(OFAsyncGetReply rep) {
     private void decodeAsyncGetReply(OFAsyncGetReply rep) {
@@ -245,21 +245,21 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
         OFMessage gtf = factory.buildTableFeaturesStatsRequest()
         OFMessage gtf = factory.buildTableFeaturesStatsRequest()
                 .setXid(getNextTransactionId())
                 .setXid(getNextTransactionId())
                 .build();
                 .build();
-        sendMsg(gtf);
+        sendHandshakeMessage(gtf);
     }
     }
 
 
     private void sendGroupFeaturesRequest() throws IOException {
     private void sendGroupFeaturesRequest() throws IOException {
         OFMessage gfr = factory.buildGroupFeaturesStatsRequest()
         OFMessage gfr = factory.buildGroupFeaturesStatsRequest()
                 .setXid(getNextTransactionId())
                 .setXid(getNextTransactionId())
                 .build();
                 .build();
-        sendMsg(gfr);
+        sendHandshakeMessage(gfr);
     }
     }
 
 
     private void sendGroupDescRequest() throws IOException {
     private void sendGroupDescRequest() throws IOException {
         OFMessage gdr = factory.buildGroupDescStatsRequest()
         OFMessage gdr = factory.buildGroupDescStatsRequest()
                 .setXid(getNextTransactionId())
                 .setXid(getNextTransactionId())
                 .build();
                 .build();
-        sendMsg(gdr);
+        sendHandshakeMessage(gdr);
     }
     }
 
 
     /*Create L2 interface groups for all physical ports
     /*Create L2 interface groups for all physical ports
@@ -290,12 +290,12 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                         .setGroupType(OFGroupType.INDIRECT)
                         .setGroupType(OFGroupType.INDIRECT)
                         .setXid(getNextTransactionId())
                         .setXid(getNextTransactionId())
                         .build();
                         .build();
+                sendHandshakeMessage(gmAdd);
                 msglist.add(gmAdd);
                 msglist.add(gmAdd);
                 l2groups.put(pnum, gl2);
                 l2groups.put(pnum, gl2);
             }
             }
         }
         }
         log.debug("Creating {} L2 groups in sw {}", msglist.size(), getStringId());
         log.debug("Creating {} L2 groups in sw {}", msglist.size(), getStringId());
-        sendMsg(msglist);
     }
     }
 
 
     private int getVlanConfig(int portnum) {
     private int getVlanConfig(int portnum) {
@@ -394,9 +394,10 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                     .setGroupType(OFGroupType.INDIRECT)
                     .setGroupType(OFGroupType.INDIRECT)
                     .setXid(getNextTransactionId())
                     .setXid(getNextTransactionId())
                     .build();
                     .build();
-            msglist.add(gmAdd);
+            sendHandshakeMessage(gmAdd);
+
         }
         }
-        sendMsg(msglist);
+
         log.debug("Creating {} L3 groups in sw {}", msglist.size(), getStringId());
         log.debug("Creating {} L3 groups in sw {}", msglist.size(), getStringId());
     }
     }
 
 
@@ -407,7 +408,7 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
      * instead of the IP ttl
      * instead of the IP ttl
      */
      */
     private void setL25Groups() throws IOException {
     private void setL25Groups() throws IOException {
-        List<OFMessage> msglist = new ArrayList<OFMessage>();
+
         for (OFGroup gl2 : l2groups.values()) {
         for (OFGroup gl2 : l2groups.values()) {
             int gnum = gl2.getGroupNumber();
             int gnum = gl2.getGroupNumber();
             int portnum = gnum & 0x0000ffff;
             int portnum = gnum & 0x0000ffff;
@@ -445,11 +446,12 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                         .setGroupType(OFGroupType.INDIRECT)
                         .setGroupType(OFGroupType.INDIRECT)
                         .setXid(getNextTransactionId())
                         .setXid(getNextTransactionId())
                         .build();
                         .build();
-                msglist.add(gmAdd);
+                sendHandshakeMessage(gmAdd);
+
             }
             }
         }
         }
-        sendMsg(msglist);
-        log.debug("Creating {} MPLS groups in sw {}", msglist.size(), getStringId());
+
+        log.debug("Created MPLS groups in sw {}", getStringId());
     }
     }
 
 
     /* Using ECMP groups
     /* Using ECMP groups
@@ -560,13 +562,14 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                         .setHardTimeout(0)
                         .setHardTimeout(0)
                         .setXid(getNextTransactionId())
                         .setXid(getNextTransactionId())
                         .build();
                         .build();
-                msglist.add(flowEntry);
+                sendHandshakeMessage(flowEntry);
+
             }
             }
         }
         }
         // table-vlan has no table-miss entry, and so packets that miss are
         // table-vlan has no table-miss entry, and so packets that miss are
         // essentially dropped
         // essentially dropped
-        sendMsg(msglist);
-        log.debug("Adding {} vlan-rules in sw {}", msglist.size(), getStringId());
+
+        log.debug("Added vlan-rules in sw {}", getStringId());
     }
     }
 
 
     private void populateTableTMac() throws IOException {
     private void populateTableTMac() throws IOException {
@@ -617,7 +620,7 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
         List<OFMessage> msglist = new ArrayList<OFMessage>(2);
         List<OFMessage> msglist = new ArrayList<OFMessage>(2);
         msglist.add(ipEntry);
         msglist.add(ipEntry);
         msglist.add(mplsEntry);
         msglist.add(mplsEntry);
-        sendMsg(msglist);
+        msglist.stream().forEach(m -> sendHandshakeMessage(m));
     }
     }
 
 
     private List<String> getMyIps() { // send to controller
     private List<String> getMyIps() { // send to controller
@@ -762,10 +765,10 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                     .setHardTimeout(0)
                     .setHardTimeout(0)
                     .setXid(getNextTransactionId())
                     .setXid(getNextTransactionId())
                     .build();
                     .build();
-            msglist.add(myIpEntry);
+            sendHandshakeMessage(myIpEntry);
+
         }
         }
-        sendMsg(msglist);
-        log.debug("Adding {} my-ip-rules in sw {}", msglist.size(), getStringId());
+        log.debug("Added {} my-ip-rules in sw {}", getStringId());
     }
     }
 
 
     private void populateMySubnets() throws IOException {
     private void populateMySubnets() throws IOException {
@@ -804,11 +807,10 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                     .setHardTimeout(0)
                     .setHardTimeout(0)
                     .setXid(getNextTransactionId())
                     .setXid(getNextTransactionId())
                     .build();
                     .build();
-            msglist.add(myIpEntry);
+            sendHandshakeMessage(myIpEntry);
+
         }
         }
-        sendMsg(msglist);
-        log.debug("Adding {} subnet-ip-rules in sw {}", msglist.size(), getStringId());
-        msglist.clear();
+        log.debug("Added subnet-ip-rules in sw {}", getStringId());
     }
     }
 
 
     private void populateRoutes() throws IOException {
     private void populateRoutes() throws IOException {
@@ -948,10 +950,10 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                     .setHardTimeout(0)
                     .setHardTimeout(0)
                     .setXid(getNextTransactionId())
                     .setXid(getNextTransactionId())
                     .build();
                     .build();
+            sendHandshakeMessage(myMetaEntry);
             msglist.add(myMetaEntry);
             msglist.add(myMetaEntry);
 
 
         }
         }
-        sendMsg(msglist);
         log.debug("Adding {} next-hop-router-rules in sw {}", msglist.size(),
         log.debug("Adding {} next-hop-router-rules in sw {}", msglist.size(),
                 getStringId());
                 getStringId());
 
 
@@ -1007,9 +1009,9 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                     .setHardTimeout(0)
                     .setHardTimeout(0)
                     .setXid(getNextTransactionId())
                     .setXid(getNextTransactionId())
                     .build();
                     .build();
-            msglist.add(myIpEntry);
+            sendHandshakeMessage(myIpEntry);
         }
         }
-        sendMsg(msglist);
+
         log.debug("Adding {} next-hop-host-rules in sw {}", msglist.size(), getStringId());
         log.debug("Adding {} next-hop-host-rules in sw {}", msglist.size(), getStringId());
     }
     }
 
 
@@ -1081,9 +1083,10 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                     .setHardTimeout(0)
                     .setHardTimeout(0)
                     .setXid(getNextTransactionId())
                     .setXid(getNextTransactionId())
                     .build();
                     .build();
+            sendHandshakeMessage(myMplsEntry);
             msglist.add(myMplsEntry);
             msglist.add(myMplsEntry);
         }
         }
-        sendMsg(msglist);
+
         log.debug("Adding {} mpls-forwarding-rules in sw {}", msglist.size(),
         log.debug("Adding {} mpls-forwarding-rules in sw {}", msglist.size(),
                 getStringId());
                 getStringId());
 
 
@@ -1166,7 +1169,7 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                 .setXid(getNextTransactionId())
                 .setXid(getNextTransactionId())
                 .build();
                 .build();
 
 
-        sendMsg(tableMissEntry);
+        sendHandshakeMessage(tableMissEntry);
     }
     }
 
 
     private void sendBarrier(boolean finalBarrier) {
     private void sendBarrier(boolean finalBarrier) {
@@ -1179,7 +1182,7 @@ public class OFSwitchImplCPqD13 extends AbstractOpenFlowSwitch {
                 .setXid(xid)
                 .setXid(xid)
                 .build();
                 .build();
 
 
-        sendMsg(br);
+        sendHandshakeMessage(br);
     }
     }
 
 
     @Override
     @Override

@@ -136,6 +136,12 @@ public abstract class AbstractOpenFlowSwitch extends AbstractHandlerBehaviour
                                                    "a non role request message");
                                                    "a non role request message");
     }
     }
 
 
+    public final void sendHandshakeMessage(OFMessage message) {
+        if (!this.isDriverHandshakeComplete()) {
+            channel.write(Collections.singletonList(message));
+        }
+    }
+
     @Override
     @Override
     public final boolean isConnected() {
     public final boolean isConnected() {
         return this.connected;
         return this.connected;

@@ -210,4 +210,12 @@ public interface OpenFlowSwitchDriver extends OpenFlowSwitch, HandlerBehaviour {
      */
      */
     void sendRoleRequest(OFMessage message);
     void sendRoleRequest(OFMessage message);
 
 
+    /**
+     * Allows the handshaker behaviour to send messages during the
+     * handshake phase only.
+     *
+     * @param message an OpenFlow message
+     */
+    void sendHandshakeMessage(OFMessage message);
+
 }
 }

@@ -229,6 +229,10 @@ public class RoleManagerTest {
         }
         }
 
 
         @Override
         @Override
+        public void sendHandshakeMessage(OFMessage message) {
+        }
+
+        @Override
         public boolean connectSwitch() {
         public boolean connectSwitch() {
             return false;
             return false;
         }
         }