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