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 com.google.common.util.concurrent.ListenableFuture;
12 import io.netty.util.Timeout;
13 import java.math.BigInteger;
14 import java.util.List;
15 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
16 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
17 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
18 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
19 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
20 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
21 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReply;
26 * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
27 * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
28 * These attach to a particular Device Context in such a way, that there is at most one primary
29 * session associated with a Device Context. Whenever the controller needs to interact with a
30 * particular switch, it will do so in the context of the calling thread, obtaining a lock on
31 * the corresponding Device Context – thus the Device Context becomes the fine-grained point
32 * of synchronization. The only two entities allowed to send requests towards the switch are
33 * Statistics Manager and RPC Manager. Each of them allocates a Request Context for interacting
34 * with a particular Device Context. The Request Contexts are the basic units of fairness,
35 * which is enforced by keeping a cap on the number of outstanding requests a particular Request
36 * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
37 * a request to the switch will fail immediately, with proper error indication.
40 public interface DeviceContext extends
49 * Method close all auxiliary connections and primary connection.
51 void shutdownConnection();
53 void initialSubmitTransaction();
56 * Method add auxiliary connection contexts to this context representing single device connection.
57 * @param connectionContext new connection context
59 void addAuxiliaryConnectionContext(ConnectionContext connectionContext);
62 * Method removes auxiliary connection context from this context representing single device connection.
63 * @param connectionContext connection which need to be removed
65 void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
68 * Method provides state of device represented by this device context.
70 * @return {@link DeviceState}
72 DeviceState getDeviceState();
75 * Method has to close TxManager ASAP we are notified about Closed Connection
76 * @return sync. future for Slave and MD-SAL completition for Master
78 ListenableFuture<Void> shuttingDownDataStoreTransactions();
81 * @return current devices connection context
83 ConnectionContext getPrimaryConnectionContext();
86 * @return current devices auxiliary connection contexts
88 ConnectionContext getAuxiliaryConnectiobContexts(BigInteger cookie);
92 * @return translator library
94 TranslatorLibrary oook();
97 * store cancellable timeout handler of currently running barrier task
99 void setCurrentBarrierTimeout(Timeout timeout);
102 * @return cancellable timeout handle of currently running barrier task
104 Timeout getBarrierTaskTimeout();
106 void setNotificationPublishService(NotificationPublishService notificationPublishService);
108 MessageSpy getMessageSpy();
110 MultiMsgCollector getMultiMsgCollector(final RequestContext<List<MultipartReply>> requestContext);
113 * indicates that device context is fully published (e.g.: packetIn messages should be passed)
118 * change packetIn rate limiter borders
120 * @param upperBound max amount of outstanding packetIns
122 void updatePacketInRateLimit(long upperBound);
125 * @return registry point for item life cycle sources of device
127 ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
132 void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);