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 org.opendaylight.controller.md.sal.common.api.data.TransactionChain;
  12 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
  13 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MessageHandler;
  14 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
  15 import java.math.BigInteger;
  16 import java.util.Collection;
  17
  18 /**
  19  * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
  20  * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
  21  * These attach to a particular Device Context in such a way, that there is at most one primary
  22  * session associated with a Device Context. Whenever the controller needs to interact with a
  23  * particular switch, it will do so in the context of the calling thread, obtaining a lock on
  24  * the corresponding Device Context – thus the Device Context becomes the fine-grained point
  25  * of synchronization. The only two entities allowed to send requests towards the switch are
  26  * Statistics Manager and RPC Manager. Each of them allocates a Request Context for interacting
  27  * with a particular Device Context. The Request Contexts are the basic units of fairness,
  28  * which is enforced by keeping a cap on the number of outstanding requests a particular Request
  29  * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
  30  * a request to the switch will fail immediately, with proper error indication.
  31  * <p/>
  32  * Created by Martin Bobak <mbobak@cisco.com> on 25.2.2015.
  33  */
  34 public interface DeviceContext extends MessageHandler {
  35
  36
  37     /**
  38      * Method add auxiliary connection contexts to this context representing single device connection.
  39      *
  40      * @param connectionContext
  41      */
  42     void addAuxiliaryConenctionContext(ConnectionContext connectionContext);
  43
  44     /**
  45      * Method removes auxiliary connection context from this context representing single device connection.
  46      *
  47      * @param connectionContext
  48      */
  49     void removeAuxiliaryConenctionContext(ConnectionContext connectionContext);
  50
  51
  52     /**
  53      * Method provides state of device represented by this device context.
  54      *
  55      * @return {@link DeviceState}
  56      */
  57     DeviceState getDeviceState();
  58
  59     /**
  60      * Method sets transaction chain used for all data store operations on device
  61      * represented by this context. This transaction chain is write only.
  62      *
  63      * @param transactionChain
  64      */
  65     void setTransactionChain(TransactionChain transactionChain);
  66
  67     /**
  68      * Method exposes transaction created for device
  69      * represented by this context. This should be used as write only.
  70      */
  71     TransactionChain getTransactionChain();
  72
  73     /**
  74      * Method provides capabilities of connected device.
  75      *
  76      * @return
  77      */
  78     TableFeatures getCapabilities();
  79
  80     /**
  81      * Method provides current devices connection context.
  82      *
  83      * @return
  84      */
  85     ConnectionContext getPrimaryConnectionContext();
  86
  87     /**
  88      * Method provides current devices auxiliary connection contexts.
  89      *
  90      * @return
  91      */
  92     ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
  93
  94 }
  95