package org.opendaylight.openflowplugin.api.openflow.device;
+import com.google.common.util.concurrent.ListenableFuture;
+import io.netty.util.Timeout;
import java.math.BigInteger;
-import java.util.Map;
-import java.util.concurrent.Future;
-import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
-import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
-import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
-import org.opendaylight.openflowplugin.api.openflow.device.exception.DeviceDataException;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.MessageHandler;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
-import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
-import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.common.RpcResult;
-
-import com.google.common.util.concurrent.SettableFuture;
-
-import java.util.Collection;
import java.util.List;
-import java.util.Map;
-import java.util.concurrent.Future;
+import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
+import org.opendaylight.openflowplugin.api.openflow.OFPContext;
+import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
+import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
+import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
+import org.opendaylight.openflowplugin.api.openflow.lifecycle.LifecycleService;
+import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
+import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
/**
* The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
* which is enforced by keeping a cap on the number of outstanding requests a particular Request
* Context can have at any point in time. Should this quota be exceeded, any further attempt to make
* a request to the switch will fail immediately, with proper error indication.
- * <p>
- * Created by Martin Bobak <mbobak@cisco.com> on 25.2.2015.
*/
-public interface DeviceContext extends MessageHandler {
+public interface DeviceContext extends
+ OFPContext,
+ AutoCloseable,
+ DeviceReplyProcessor,
+ TxFacade,
+ DeviceRegistry{
+ /**
+ * Method close all auxiliary connections and primary connection.
+ */
+ void shutdownConnection();
/**
* Method add auxiliary connection contexts to this context representing single device connection.
- *
- * @param connectionContext
+ * @param connectionContext new connection context
*/
- void addAuxiliaryConenctionContext(ConnectionContext connectionContext);
+ void addAuxiliaryConnectionContext(ConnectionContext connectionContext);
/**
* Method removes auxiliary connection context from this context representing single device connection.
- *
- * @param connectionContext
+ * @param connectionContext connection which need to be removed
*/
- void removeAuxiliaryConenctionContext(ConnectionContext connectionContext);
-
+ void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
/**
* Method provides state of device represented by this device context.
DeviceState getDeviceState();
/**
- * Method exposes transaction created for device
- * represented by this context. This should be used as write only.
+ * Method has to close TxManager ASAP we are notified about Closed Connection
+ * @return sync. future for Slave and MD-SAL completition for Master
*/
- WriteTransaction getWriteTransaction();
+ ListenableFuture<Void> shuttingDownDataStoreTransactions();
/**
- * Method exposes transaction created for device
- * represented by this context. This should be used as read only.
- * This read only transaction has a fresh dataStore snapshot and
- * here is a possibility to get different data set from DataStore
- * as have a write transaction in this context.
+ * @return current devices connection context
*/
- ReadTransaction getReadTransaction();
+ ConnectionContext getPrimaryConnectionContext();
/**
- * Method provides capabilities of connected device.
- *
- * @return
+ * @return current devices auxiliary connection contexts
*/
- TableFeatures getCapabilities();
+ ConnectionContext getAuxiliaryConnectionContexts(BigInteger cookie);
+
/**
- * Method provides current devices connection context.
- *
- * @return
+ * @return translator library
*/
- ConnectionContext getPrimaryConnectionContext();
+ TranslatorLibrary oook();
/**
- * Method provides current devices auxiliary connection contexts.
- *
- * @return
+ * store cancellable timeout handler of currently running barrier task
*/
- ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
+ void setCurrentBarrierTimeout(Timeout timeout);
- Xid getNextXid();
+ /**
+ * @return cancellable timeout handle of currently running barrier task
+ */
+ Timeout getBarrierTaskTimeout();
+
+ void setNotificationPublishService(NotificationPublishService notificationPublishService);
+
+ MessageSpy getMessageSpy();
+
+ MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
/**
- * Method writes request context into request context map
- * @param xid
- * @param requestFutureContext
+ * indicates that device context is fully published (e.g.: packetIn messages should be passed)
+ */
+ void onPublished();
+
+ /**
+ * change packetIn rate limiter borders
+ *
+ * @param upperBound max amount of outstanding packetIns
*/
- public void hookRequestCtx(Xid xid, RequestContext requestFutureContext);
+ void updatePacketInRateLimit(long upperBound);
+
+ /**
+ * @return registry point for item life cycle sources of device
+ */
+ ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
+
+ @Override
+ void close();
+
+ void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);
+
+ void putLifecycleServiceIntoTxChainManager(LifecycleService lifecycleService);
+
+ void replaceConnectionContext(ConnectionContext connectionContext);
+ boolean isSkipTableFeatures();
}
Code Review / openflowplugin.git / blobdiff