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.List;
import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
-import org.opendaylight.controller.md.sal.binding.api.NotificationService;
-import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
-import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
-import org.opendaylight.openflowplugin.api.openflow.OpenFlowPluginTimer;
+import org.opendaylight.openflowplugin.api.openflow.OFPContext;
import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceContextClosedHandler;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceDisconnectedHandler;
import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.MessageHandler;
import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
-import org.opendaylight.openflowplugin.api.openflow.device.handlers.OutstandingMessageExtractor;
-import org.opendaylight.openflowplugin.api.openflow.device.listener.OpenflowMessageListenerFacade;
-import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
-import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
-import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
+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.openflowplugin.api.openflow.translator.TranslatorLibrarian;
-import org.opendaylight.yangtools.yang.binding.DataObject;
-import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
/**
- * <p>
* The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
* as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
* These attach to a particular Device Context in such a way, that there is at most one primary
* 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 AutoCloseable,
- OpenFlowPluginTimer,
- MessageHandler,
- TranslatorLibrarian,
- OutstandingMessageExtractor,
+public interface DeviceContext extends
+ OFPContext,
+ AutoCloseable,
DeviceReplyProcessor,
- DeviceDisconnectedHandler {
+ 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 creates put operation using provided data in underlying transaction chain.
+ * Method has to close TxManager ASAP we are notified about Closed Connection
+ * @return sync. future for Slave and MD-SAL completition for Master
*/
- <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store, final InstanceIdentifier<T> path, final T data);
+ ListenableFuture<Void> shuttingDownDataStoreTransactions();
/**
- * Method creates delete operation for provided path in underlying transaction chain.
- */
- <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path);
-
- /**
- * Method exposes transaction created for device
- * represented by this context. This read only transaction has a fresh dataStore snapshot.
- * There is a possibility to get different data set from DataStore
- * as write transaction in this context.
- */
- ReadTransaction getReadTransaction();
-
-
- /**
- * Method provides current devices connection context.
- *
- * @return
+ * @return current devices connection context
*/
ConnectionContext getPrimaryConnectionContext();
/**
- * Method provides current devices auxiliary connection contexts.
- *
- * @return
+ * @return current devices auxiliary connection contexts
*/
- ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
+ ConnectionContext getAuxiliaryConnectionContexts(BigInteger cookie);
- /**
- * Method generates unique XID value.
- *
- * @return
- */
- Xid getNextXid();
-
- /**
- * @param xid key
- * @return request by xid
- */
- RequestContext lookupRequest(Xid xid);
/**
- * @return number of outstanding requests in map
+ * @return translator library
*/
- int getNumberOfOutstandingRequests();
+ TranslatorLibrary oook();
/**
- * Method writes request context into request context map. This method
- * is ment to be used by org.opendaylight.openflowplugin.impl.services.OFJResult2RequestCtxFuture#processResultFromOfJava.
- *
- * @param xid
- * @param requestFutureContext
- */
- void hookRequestCtx(Xid xid, RequestContext requestFutureContext);
-
- /**
- * Method removes request context from request context map.
- *
- * @param xid
- */
- RequestContext unhookRequestCtx(Xid xid);
-
- /**
- * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
- *
- * @return
+ * store cancellable timeout handler of currently running barrier task
*/
- DeviceFlowRegistry getDeviceFlowRegistry();
+ void setCurrentBarrierTimeout(Timeout timeout);
/**
- * Method exposes device group registry used for storing group ids.
- *
- * @return
+ * @return cancellable timeout handle of currently running barrier task
*/
- DeviceGroupRegistry getDeviceGroupRegistry();
+ Timeout getBarrierTaskTimeout();
- /**
- * Method exposes device meter registry used for storing meter ids.
- *
- * @return
- */
- DeviceMeterRegistry getDeviceMeterRegistry();
+ void setNotificationPublishService(NotificationPublishService notificationPublishService);
+ MessageSpy getMessageSpy();
- /**
- * store cancellable timeout handler of currently running barrier task
- */
- void setCurrentBarrierTimeout(Timeout timeout);
+ MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
/**
- * @return cancellable timeout handle of currently running barrier task
+ * indicates that device context is fully published (e.g.: packetIn messages should be passed)
*/
- Timeout getBarrierTaskTimeout();
+ void onPublished();
/**
- * Sets notification service
+ * change packetIn rate limiter borders
*
- * @param notificationService
+ * @param upperBound max amount of outstanding packetIns
*/
- void setNotificationService(NotificationService notificationService);
-
- void setNotificationPublishService(NotificationPublishService notificationPublishService);
-
- MessageSpy getMessageSpy();
-
- void setDeviceDisconnectedHandler(DeviceDisconnectedHandler deviceDisconnectedHandler);
+ void updatePacketInRateLimit(long upperBound);
/**
- * Method sets reference to handler used for cleanup after device context about to be closed.
+ * @return registry point for item life cycle sources of device
*/
- void addDeviceContextClosedHandler(DeviceContextClosedHandler deviceContextClosedHandler);
+ ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
+
+ @Override
+ void close();
- void startGatheringOperationsToOneTransaction();
+ void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);
- void commitOperationsGatheredInOneTransaction();
+ void putLifecycleServiceIntoTxChainManager(LifecycleService lifecycleService);
- public MultiMsgCollector getMultiMsgCollector();
+ void replaceConnectionContext(ConnectionContext connectionContext);
+ boolean isSkipTableFeatures();
}
Code Review / openflowplugin.git / blobdiff