simple-client/src/main/java/org/opendaylight/openflowjava/protocol/impl/clients/OFClient.java

   1 /*
   2  * Copyright (c) 2014 Pantheon Technologies s.r.o. and others. All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.openflowjava.protocol.impl.clients;
  10
  11 import com.google.common.util.concurrent.SettableFuture;
  12
  13 /**
  14  * Unifying interface for simple clients / switch simulators
  15  *
  16  * @author michal.polkorab
  17  */
  18 public interface OFClient extends Runnable {
  19
  20     /**
  21      * @return the isOnlineFuture which is set when client is started
  22      */
  23     SettableFuture<Boolean> getIsOnlineFuture();
  24
  25     /**
  26      * @return the scenarioDone when scenario is successfully finished
  27      */
  28     SettableFuture<Boolean> getScenarioDone();
  29
  30     /**
  31      * @param scenario list of desired actions
  32      */
  33     void setScenarioHandler(ScenarioHandler scenario);
  34
  35     /**
  36      * @param securedClient true is client should use encrypted communication,
  37      * false otherwise
  38      */
  39     void setSecuredClient(boolean securedClient);
  40 }