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 io.netty.util.Timeout;
  12 import java.math.BigInteger;
  13 import java.util.List;
  14 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  15 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
  16 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
  17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  18 import org.opendaylight.openflowplugin.api.openflow.OpenFlowPluginTimer;
  19 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  20 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceContextClosedHandler;
  21 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceDisconnectedHandler;
  22 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
  23 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MessageHandler;
  24 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
  25 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
  26 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
  27 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
  28 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
  29 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
  31 import org.opendaylight.yangtools.yang.binding.DataObject;
  32 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  33
  34 /**
  35  * <p>
  36  * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
  37  * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
  38  * These attach to a particular Device Context in such a way, that there is at most one primary
  39  * session associated with a Device Context. Whenever the controller needs to interact with a
  40  * particular switch, it will do so in the context of the calling thread, obtaining a lock on
  41  * the corresponding Device Context – thus the Device Context becomes the fine-grained point
  42  * of synchronization. The only two entities allowed to send requests towards the switch are
  43  * Statistics Manager and RPC Manager. Each of them allocates a Request Context for interacting
  44  * with a particular Device Context. The Request Contexts are the basic units of fairness,
  45  * which is enforced by keeping a cap on the number of outstanding requests a particular Request
  46  * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
  47  * a request to the switch will fail immediately, with proper error indication.
  48  * </p>
  49  * Created by Martin Bobak &lt;mbobak@cisco.com&gt; on 25.2.2015.
  50  */
  51 public interface DeviceContext extends AutoCloseable,
  52         OpenFlowPluginTimer,
  53         MessageHandler,
  54         DeviceReplyProcessor,
  55         DeviceDisconnectedHandler,
  56         PortNumberCache {
  57
  58
  59     /**
  60      * Method add auxiliary connection contexts to this context representing single device connection.
  61      *
  62      * @param connectionContext
  63      */
  64     void addAuxiliaryConenctionContext(ConnectionContext connectionContext);
  65
  66     /**
  67      * Method removes auxiliary connection context from this context representing single device connection.
  68      *
  69      * @param connectionContext
  70      */
  71     void removeAuxiliaryConenctionContext(ConnectionContext connectionContext);
  72
  73
  74     /**
  75      * Method provides state of device represented by this device context.
  76      *
  77      * @return {@link DeviceState}
  78      */
  79     DeviceState getDeviceState();
  80
  81     /**
  82      * Method creates put operation using provided data in underlying transaction chain.
  83      */
  84     <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store, final InstanceIdentifier<T> path, final T data);
  85
  86     /**
  87      * Method creates delete operation for provided path in underlying transaction chain.
  88      */
  89     <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path);
  90
  91     /**
  92      * Method submits Transaction to DataStore.
  93      * @return transaction is submitted successfully
  94      */
  95     boolean submitTransaction();
  96
  97     /**
  98      * Method exposes transaction created for device
  99      * represented by this context. This read only transaction has a fresh dataStore snapshot.
 100      * There is a possibility to get different data set from  DataStore
 101      * as write transaction in this context.
 102      */
 103     ReadTransaction getReadTransaction();
 104
 105
 106     /**
 107      * Method provides current devices connection context.
 108      *
 109      * @return
 110      */
 111     ConnectionContext getPrimaryConnectionContext();
 112
 113     /**
 114      * Method provides current devices auxiliary connection contexts.
 115      *
 116      * @return
 117      */
 118     ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
 119
 120     /**
 121      * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
 122      *
 123      * @return
 124      */
 125     DeviceFlowRegistry getDeviceFlowRegistry();
 126
 127     /**
 128      * Method exposes device group registry used for storing group ids.
 129      *
 130      * @return
 131      */
 132     DeviceGroupRegistry getDeviceGroupRegistry();
 133
 134     /**
 135      * Method exposes device meter registry used for storing meter ids.
 136      *
 137      * @return
 138      */
 139     DeviceMeterRegistry getDeviceMeterRegistry();
 140
 141
 142     /**
 143      * @return translator library
 144      */
 145     TranslatorLibrary oook();
 146
 147     /**
 148      * store cancellable timeout handler of currently running barrier task
 149      */
 150     void setCurrentBarrierTimeout(Timeout timeout);
 151
 152     /**
 153      * @return cancellable timeout handle of currently running barrier task
 154      */
 155     Timeout getBarrierTaskTimeout();
 156
 157     /**
 158      * Sets notification service
 159      *
 160      * @param notificationService
 161      */
 162     void setNotificationService(NotificationService notificationService);
 163
 164     void setNotificationPublishService(NotificationPublishService notificationPublishService);
 165
 166     MessageSpy getMessageSpy();
 167
 168     /**
 169      * Method sets reference to handler used for cleanup after device context about to be closed.
 170      */
 171     void addDeviceContextClosedHandler(DeviceContextClosedHandler deviceContextClosedHandler);
 172
 173     MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
 174
 175     Long getReservedXid();
 176
 177     /**
 178      * indicates that device context is fully published (e.g.: packetIn messages should be passed)
 179      */
 180     void onPublished();
 181
 182     /**
 183      * change packetIn rate limiter borders
 184      *
 185      * @param upperBound max amount of outstanding packetIns
 186      */
 187     void updatePacketInRateLimit(long upperBound);
 188
 189     /**
 190      * @return registry point for item life cycle sources of device
 191      */
 192     ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
 193 }
 194