openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.openflowplugin.api.openflow.device;
  10
  11 import com.google.common.util.concurrent.ListenableFuture;
  12 import io.netty.util.Timeout;
  13 import java.math.BigInteger;
  14 import java.util.List;
  15 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  16 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
  17 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  18 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
  19 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  20 import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
  21 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
  22 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  24
  25 /**
  26  * <p>
  27  * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
  28  * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
  29  * These attach to a particular Device Context in such a way, that there is at most one primary
  30  * session associated with a Device Context. Whenever the controller needs to interact with a
  31  * particular switch, it will do so in the context of the calling thread, obtaining a lock on
  32  * the corresponding Device Context – thus the Device Context becomes the fine-grained point
  33  * of synchronization. The only two entities allowed to send requests towards the switch are
  34  * Statistics Manager and RPC Manager. Each of them allocates a Request Context for interacting
  35  * with a particular Device Context. The Request Contexts are the basic units of fairness,
  36  * which is enforced by keeping a cap on the number of outstanding requests a particular Request
  37  * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
  38  * a request to the switch will fail immediately, with proper error indication.
  39  * </p>
  40  */
  41 public interface DeviceContext extends
  42         OFPContext,
  43         AutoCloseable,
  44         DeviceReplyProcessor,
  45         TxFacade,
  46         DeviceRegistry{
  47
  48     /**
  49      * Method close all auxiliary connections and primary connection.
  50      */
  51     void shutdownConnection();
  52
  53     /**
  54      * Initial submit transaction
  55      */
  56     void initialSubmitTransaction();
  57
  58     /**
  59      * Method add auxiliary connection contexts to this context representing single device connection.
  60      * @param connectionContext new connection context
  61      */
  62     void addAuxiliaryConnectionContext(ConnectionContext connectionContext);
  63
  64     /**
  65      * Method removes auxiliary connection context from this context representing single device connection.
  66      * @param connectionContext connection which need to be removed
  67      */
  68     void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
  69
  70     /**
  71      * Method provides state of device represented by this device context.
  72      *
  73      * @return {@link DeviceState}
  74      */
  75     DeviceState getDeviceState();
  76
  77     /**
  78      * Method has to close TxManager ASAP we are notified about Closed Connection
  79      * @return sync. future for Slave and MD-SAL completition for Master
  80      */
  81     ListenableFuture<Void> shuttingDownDataStoreTransactions();
  82
  83     /**
  84      * @return current devices connection context
  85      */
  86     ConnectionContext getPrimaryConnectionContext();
  87
  88     /**
  89      * @return current devices auxiliary connection contexts
  90      */
  91     ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
  92
  93
  94     /**
  95      * @return translator library
  96      */
  97     TranslatorLibrary oook();
  98
  99     /**
 100      * store cancellable timeout handler of currently running barrier task
 101      */
 102     void setCurrentBarrierTimeout(Timeout timeout);
 103
 104     /**
 105      * @return cancellable timeout handle of currently running barrier task
 106      */
 107     Timeout getBarrierTaskTimeout();
 108
 109     void setNotificationPublishService(NotificationPublishService notificationPublishService);
 110
 111     MessageSpy getMessageSpy();
 112
 113     MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
 114
 115     /**
 116      * indicates that device context is fully published (e.g.: packetIn messages should be passed)
 117      */
 118     void onPublished();
 119
 120     /**
 121      * change packetIn rate limiter borders
 122      *
 123      * @param upperBound max amount of outstanding packetIns
 124      */
 125     void updatePacketInRateLimit(long upperBound);
 126
 127     /**
 128      * @return registry point for item life cycle sources of device
 129      */
 130     ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
 131
 132     @Override
 133     void close();
 134
 135     void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);
 136
 137     void putLifecycleServiceIntoTxChainManager(LifecycleService lifecycleService);
 138
 139     void replaceConnectionContext(ConnectionContext connectionContext);
 140
 141     boolean isSkipTableFeatures();
 142 }
 143