2 * Copyright (c) 2015 Cisco Systems, Inc. and others. All rights reserved.
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
9 package org.opendaylight.openflowplugin.api.openflow.device;
11 import org.opendaylight.controller.sal.binding.api.NotificationProviderService;
13 import io.netty.util.Timeout;
14 import java.math.BigInteger;
16 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
18 import org.opendaylight.openflowplugin.api.openflow.OpenflowPluginTimer;
19 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
20 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
21 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MessageHandler;
22 import org.opendaylight.openflowplugin.api.openflow.device.handlers.OutstandingMessageExtractor;
23 import org.opendaylight.openflowplugin.api.openflow.device.listener.OpenflowMessageListenerFacade;
24 import org.opendaylight.openflowplugin.api.openflow.flow.registry.DeviceFlowRegistry;
25 import org.opendaylight.openflowplugin.api.openflow.translator.TranslatorLibrarian;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.TableFeatures;
27 import org.opendaylight.yangtools.yang.binding.DataObject;
28 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
31 * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
32 * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
33 * These attach to a particular Device Context in such a way, that there is at most one primary
34 * session associated with a Device Context. Whenever the controller needs to interact with a
35 * particular switch, it will do so in the context of the calling thread, obtaining a lock on
36 * the corresponding Device Context – thus the Device Context becomes the fine-grained point
37 * of synchronization. The only two entities allowed to send requests towards the switch are
38 * Statistics Manager and RPC Manager. Each of them allocates a Request Context for interacting
39 * with a particular Device Context. The Request Contexts are the basic units of fairness,
40 * which is enforced by keeping a cap on the number of outstanding requests a particular Request
41 * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
42 * a request to the switch will fail immediately, with proper error indication.
44 * Created by Martin Bobak <mbobak@cisco.com> on 25.2.2015.
46 public interface DeviceContext extends OpenflowPluginTimer, MessageHandler, TranslatorLibrarian, OutstandingMessageExtractor, DeviceReplyProcessor {
50 * Method add auxiliary connection contexts to this context representing single device connection.
52 * @param connectionContext
54 void addAuxiliaryConenctionContext(ConnectionContext connectionContext);
57 * Method removes auxiliary connection context from this context representing single device connection.
59 * @param connectionContext
61 void removeAuxiliaryConenctionContext(ConnectionContext connectionContext);
65 * Method provides state of device represented by this device context.
67 * @return {@link DeviceState}
69 DeviceState getDeviceState();
72 * Method creates put operation using provided data in underlying transaction chain.
74 <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store, final InstanceIdentifier<T> path, final T data);
77 * Method creates delete operation for provided path in underlying transaction chain.
79 <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path);
82 * Method exposes transaction created for device
83 * represented by this context. This read only transaction has a fresh dataStore snapshot.
84 * There is a possibility to get different data set from DataStore
85 * as write transaction in this context.
87 ReadTransaction getReadTransaction();
91 * Method provides capabilities of connected device.
95 TableFeatures getCapabilities();
98 * Method provides current devices connection context.
102 ConnectionContext getPrimaryConnectionContext();
105 * Method provides current devices auxiliary connection contexts.
109 ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
112 * Method generates unique XID value.
118 * @return readonly map of outstanding requests
120 Map<Long, RequestContext> getRequests();
123 * Method writes request context into request context map. This method
124 * is ment to be used by {@link org.opendaylight.openflowplugin.impl.services.OFJResult2RequestCtxFuture#processResultFromOfJava}
127 * @param requestFutureContext
129 void hookRequestCtx(Xid xid, RequestContext requestFutureContext);
132 * Method that attaches anyMessageTypeListener to connection adapters as message listener.
134 * @param openflowMessageListenerFacade
136 void attachOpenflowMessageListener(OpenflowMessageListenerFacade openflowMessageListenerFacade);
139 * Method returns registered {@link org.opendaylight.openflowplugin.api.openflow.device.listener.OpenflowMessageListenerFacade}
142 OpenflowMessageListenerFacade getOpenflowMessageListenerFacade();
145 * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
148 DeviceFlowRegistry getDeviceFlowRegistry();
151 * store cancellable timeout handler of currently running barrier task
153 void setCurrentBarrierTimeout(Timeout timeout);
156 * @return cancellable timeout handle of currently running barrier task
158 Timeout getBarrierTaskTimeout();
161 * Sets notification service
162 * @param notificationService
164 void setNotificationService(NotificationProviderService notificationService);