X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=openflowplugin-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fopenflowplugin%2Fapi%2Fopenflow%2Fdevice%2FDeviceContext.java;h=6f4bad3e38032cba0ac766e7be212a9f84dd68a8;hb=refs%2Fchanges%2F93%2F19093%2F2;hp=0dce8206aab98d00b8de6166b481a1aebc22e105;hpb=38eaf1d1424b401f8614c18c25a7bf2e1346f88d;p=openflowplugin.git diff --git a/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java b/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java index 0dce8206aa..6f4bad3e38 100644 --- a/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java +++ b/openflowplugin-api/src/main/java/org/opendaylight/openflowplugin/api/openflow/device/DeviceContext.java @@ -8,19 +8,29 @@ 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; /** + *

* 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 @@ -33,10 +43,16 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier; * 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. - *

+ *

* Created by Martin Bobak <mbobak@cisco.com> on 25.2.2015. */ -public interface DeviceContext extends MessageHandler, TranslatorLibrarian, OutstandingMessageExtractor { +public interface DeviceContext extends AutoCloseable, + OpenFlowPluginTimer, + MessageHandler, + TranslatorLibrarian, + OutstandingMessageExtractor, + DeviceReplyProcessor, + DeviceDisconnectedHandler { /** @@ -62,25 +78,23 @@ public interface DeviceContext extends MessageHandler, TranslatorLibrarian, Outs 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. */ void writeToTransaction(final LogicalDatastoreType store, final InstanceIdentifier 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(); + void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier 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. @@ -96,16 +110,101 @@ public interface DeviceContext extends MessageHandler, TranslatorLibrarian, Outs */ ConnectionContext getAuxiliaryConnectiobContexts(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 + */ + int getNumberOfOutstandingRequests(); + /** * Method writes request context into request context map. This method - * is ment to be used by {@link org.opendaylight.openflowplugin.impl.services.OFJResult2RequestCtxFuture#processResultFromOfJava} + * 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 removes request context from request context map. + * + * @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. + */ + void addDeviceContextClosedHandler(DeviceContextClosedHandler deviceContextClosedHandler); }