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 io.netty.util.Timeout;
12 import java.math.BigInteger;
13 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
14 import org.opendaylight.controller.md.sal.binding.api.NotificationService;
15 import org.opendaylight.controller.md.sal.binding.api.ReadTransaction;
16 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
17 import org.opendaylight.openflowplugin.api.openflow.OpenFlowPluginTimer;
18 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
19 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceContextClosedHandler;
20 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceDisconnectedHandler;
21 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
22 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MessageHandler;
23 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
24 import org.opendaylight.openflowplugin.api.openflow.device.handlers.OutstandingMessageExtractor;
25 import org.opendaylight.openflowplugin.api.openflow.registry.flow.DeviceFlowRegistry;
26 import org.opendaylight.openflowplugin.api.openflow.registry.group.DeviceGroupRegistry;
27 import org.opendaylight.openflowplugin.api.openflow.registry.meter.DeviceMeterRegistry;
28 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
29 import org.opendaylight.openflowplugin.api.openflow.translator.TranslatorLibrarian;
30 import org.opendaylight.yangtools.yang.binding.DataObject;
31 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
35 * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
36 * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
37 * These attach to a particular Device Context in such a way, that there is at most one primary
38 * session associated with a Device Context. Whenever the controller needs to interact with a
39 * particular switch, it will do so in the context of the calling thread, obtaining a lock on
40 * the corresponding Device Context – thus the Device Context becomes the fine-grained point
41 * of synchronization. The only two entities allowed to send requests towards the switch are
42 * Statistics Manager and RPC Manager. Each of them allocates a Request Context for interacting
43 * with a particular Device Context. The Request Contexts are the basic units of fairness,
44 * which is enforced by keeping a cap on the number of outstanding requests a particular Request
45 * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
46 * a request to the switch will fail immediately, with proper error indication.
48 * Created by Martin Bobak <mbobak@cisco.com> on 25.2.2015.
50 public interface DeviceContext extends AutoCloseable,
54 OutstandingMessageExtractor,
56 DeviceDisconnectedHandler {
60 * Method add auxiliary connection contexts to this context representing single device connection.
62 * @param connectionContext
64 void addAuxiliaryConenctionContext(ConnectionContext connectionContext);
67 * Method removes auxiliary connection context from this context representing single device connection.
69 * @param connectionContext
71 void removeAuxiliaryConenctionContext(ConnectionContext connectionContext);
75 * Method provides state of device represented by this device context.
77 * @return {@link DeviceState}
79 DeviceState getDeviceState();
82 * Method creates put operation using provided data in underlying transaction chain.
84 <T extends DataObject> void writeToTransaction(final LogicalDatastoreType store, final InstanceIdentifier<T> path, final T data);
87 * Method creates delete operation for provided path in underlying transaction chain.
89 <T extends DataObject> void addDeleteToTxChain(final LogicalDatastoreType store, final InstanceIdentifier<T> path);
92 * Method exposes transaction created for device
93 * represented by this context. This read only transaction has a fresh dataStore snapshot.
94 * There is a possibility to get different data set from DataStore
95 * as write transaction in this context.
97 ReadTransaction getReadTransaction();
101 * Method provides current devices connection context.
105 ConnectionContext getPrimaryConnectionContext();
108 * Method provides current devices auxiliary connection contexts.
112 ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
117 * @return request by xid
119 RequestContext lookupRequest(Xid xid);
122 * @return number of outstanding requests in map
124 int getNumberOfOutstandingRequests();
127 * Method writes request context into request context map. This method
128 * is ment to be used by org.opendaylight.openflowplugin.impl.services.OFJResult2RequestCtxFuture#processResultFromOfJava.
131 * @param requestFutureContext
133 void hookRequestCtx(Xid xid, RequestContext requestFutureContext);
136 * Method removes request context from request context map.
140 RequestContext unhookRequestCtx(Xid xid);
143 * Method exposes flow registry used for storing flow ids identified by calculated flow hash.
147 DeviceFlowRegistry getDeviceFlowRegistry();
150 * Method exposes device group registry used for storing group ids.
154 DeviceGroupRegistry getDeviceGroupRegistry();
157 * Method exposes device meter registry used for storing meter ids.
161 DeviceMeterRegistry getDeviceMeterRegistry();
165 * store cancellable timeout handler of currently running barrier task
167 void setCurrentBarrierTimeout(Timeout timeout);
170 * @return cancellable timeout handle of currently running barrier task
172 Timeout getBarrierTaskTimeout();
175 * Sets notification service
177 * @param notificationService
179 void setNotificationService(NotificationService notificationService);
181 void setNotificationPublishService(NotificationPublishService notificationPublishService);
183 MessageSpy getMessageSpy();
185 void setDeviceDisconnectedHandler(DeviceDisconnectedHandler deviceDisconnectedHandler);
188 * Method sets reference to handler used for cleanup after device context about to be closed.
190 void addDeviceContextClosedHandler(DeviceContextClosedHandler deviceContextClosedHandler);
192 void startGatheringOperationsToOneTransaction();
194 void commitOperationsGatheredInOneTransaction();
196 public MultiMsgCollector getMultiMsgCollector();
198 Long getReservedXid();