package org.opendaylight.openflowplugin.api.openflow.device;
+import io.netty.util.Timeout;
import java.math.BigInteger;
import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
+import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
+import org.opendaylight.openflowplugin.api.openflow.OpenflowPluginTimer;
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.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.statistics.ofpspecific.MessageSpy;
+import org.opendaylight.openflowplugin.api.openflow.translator.TranslatorLibrarian;
import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
/**
+ * <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>
+ * </p>
* Created by Martin Bobak <mbobak@cisco.com> on 25.2.2015.
*/
-public interface DeviceContext extends MessageHandler {
+public interface DeviceContext extends AutoCloseable,
+ OpenflowPluginTimer,
+ MessageHandler,
+ TranslatorLibrarian,
+ OutstandingMessageExtractor,
+ DeviceReplyProcessor,
+ DeviceDisconnectedHandler {
/**
DeviceState getDeviceState();
/**
- * Method exposes possibility for write a child of {@link DataObject} to transaction for DataStore.
+ * Method creates put operation using provided data in underlying transaction chain.
*/
<T extends DataObject> void writeToTransaction(final LogicalDatastoreType store, final InstanceIdentifier<T> path, final T data);
/**
- * 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.
+ * Method creates delete operation for provided path in underlying transaction chain.
*/
- ReadTransaction getReadTransaction();
+ <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path);
/**
- * Method provides capabilities of connected device.
- *
- * @return
+ * 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.
*/
- TableFeatures getCapabilities();
+ ReadTransaction getReadTransaction();
+
/**
* Method provides current devices connection context.
*/
ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
+ /**
+ * Method generates unique XID value.
+ *
+ * @return
+ */
Xid getNextXid();
/**
- * Method writes request context into request context map
+ * @param xid key
+ * @return request by xid
+ */
+ RequestContext lookupRequest(Xid xid);
+
+ /**
+ * @return number of outstanding requests in map
+ */
+ int getNumberOfOutstandingRequests();
+
+ /**
+ * 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
*/
- public void hookRequestCtx(Xid xid, RequestContext requestFutureContext);
+ void hookRequestCtx(Xid xid, RequestContext requestFutureContext);
/**
- * Method registers translator library for translating message objects.
+ * Method removes request context from request context map.
*
- * @param translatorLibrary
+ * @param xid
+ */
+ RequestContext unhookRequestCtx(Xid xid);
+
+ /**
+ * Method that attaches anyMessageTypeListener to connection adapters as message listener.
+ *
+ * @param openflowMessageListenerFacade
+ */
+ void attachOpenflowMessageListener(OpenflowMessageListenerFacade openflowMessageListenerFacade);
+
+ /**
+ * Method returns registered {@link org.opendaylight.openflowplugin.api.openflow.device.listener.OpenflowMessageListenerFacade}
+ *
+ * @return
+ */
+ OpenflowMessageListenerFacade getOpenflowMessageListenerFacade();
+
+ /**
+ * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
+ *
+ * @return
+ */
+ DeviceFlowRegistry getDeviceFlowRegistry();
+
+ /**
+ * Method exposes device group registry used for storing group ids.
+ *
+ * @return
+ */
+ DeviceGroupRegistry getDeviceGroupRegistry();
+
+ /**
+ * Method exposes device meter registry used for storing meter ids.
+ *
+ * @return
+ */
+ DeviceMeterRegistry getDeviceMeterRegistry();
+
+
+ /**
+ * store cancellable timeout handler of currently running barrier task
+ */
+ void setCurrentBarrierTimeout(Timeout timeout);
+
+ /**
+ * @return cancellable timeout handle of currently running barrier task
+ */
+ Timeout getBarrierTaskTimeout();
+
+ /**
+ * Sets notification service
+ *
+ * @param notificationService
+ */
+ void setNotificationService(NotificationProviderService notificationService);
+
+ MessageSpy getMessageSpy();
+
+ void setDeviceDisconnectedHandler(DeviceDisconnectedHandler deviceDisconnectedHandler);
+
+ /**
+ * Method sets reference to handler used for cleanup after device context about to be closed.
*/
- public void setTranslatorLibrary(TranslatorLibrary translatorLibrary);
+ void addDeviceContextClosedHandler(DeviceContextClosedHandler deviceContextClosedHandler);
}
Code Review / openflowplugin.git / blobdiff