openflow-protocol-spi/src/main/java/org/opendaylight/openflowjava/protocol/spi/connection/SwitchConnectionProvider.java

   1 /*
   2  * Copyright (c) 2013 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
  10 package org.opendaylight.openflowjava.protocol.spi.connection;
  11
  12 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionConfiguration;
  13 import org.opendaylight.openflowjava.protocol.api.connection.SwitchConnectionHandler;
  14 import org.opendaylight.openflowjava.protocol.api.extensibility.MessageTypeKey;
  15 import org.opendaylight.openflowjava.protocol.api.extensibility.OFSerializer;
  16 import org.opendaylight.yangtools.yang.binding.DataObject;
  17
  18 import com.google.common.util.concurrent.ListenableFuture;
  19
  20 /**
  21  * @author mirehak
  22  * @author michal.polkorab
  23  *
  24  */
  25 public interface SwitchConnectionProvider extends AutoCloseable {
  26
  27     /**
  28      * @param configuration [protocol, port, address and supported features]
  29      */
  30     void setConfiguration(ConnectionConfiguration configuration);
  31
  32     /**
  33      * start listening to switches, but please don't forget to do
  34      * {@link #setSwitchConnectionHandler(SwitchConnectionHandler)} first
  35      * @return future, triggered to true, when listening channel is up and running
  36      */
  37     ListenableFuture<Boolean> startup();
  38
  39     /**
  40      * stop listening to switches
  41      * @return future, triggered to true, when all listening channels are down
  42      */
  43     ListenableFuture<Boolean> shutdown();
  44
  45     /**
  46      * @param switchConHandler instance being informed when new switch connects
  47      */
  48     void setSwitchConnectionHandler(SwitchConnectionHandler switchConHandler);
  49
  50     /**
  51      * Registers custom serializer
  52      * @param key used for serializer lookup
  53      * @param serializer serializer implementation
  54      */
  55     public  <E extends DataObject> void registerCustomSerializer(MessageTypeKey<E> key,
  56             OFSerializer<E> serializer);
  57 }