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 javax.annotation.Nonnull;
16 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
17 import org.opendaylight.openflowplugin.api.openflow.OFPContext;
18 import org.opendaylight.openflowplugin.api.openflow.connection.ConnectionContext;
19 import org.opendaylight.openflowplugin.api.openflow.device.handlers.DeviceReplyProcessor;
20 import org.opendaylight.openflowplugin.api.openflow.device.handlers.MultiMsgCollector;
21 import org.opendaylight.openflowplugin.api.openflow.lifecycle.ContextChainStateListener;
22 import org.opendaylight.openflowplugin.api.openflow.registry.ItemLifeCycleRegistry;
23 import org.opendaylight.openflowplugin.api.openflow.statistics.ofpspecific.MessageSpy;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SalRoleService;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.role.service.rev150727.SetRoleOutput;
27 import org.opendaylight.yangtools.yang.common.RpcResult;
30 * The central entity of OFP is the Device Context, which encapsulate the logical state of a switch
31 * as seen by the controller. Each OpenFlow session is tracked by a Connection Context.
32 * These attach to a particular Device Context in such a way, that there is at most one primary
33 * session associated with a Device Context. Whenever the controller needs to interact with a
34 * particular switch, it will do so in the context of the calling thread, obtaining a lock on
35 * the corresponding Device Context – thus the Device Context becomes the fine-grained point
36 * of synchronization. The only two entities allowed to send requests towards the switch are
37 * Statistics Manager and RPC Manager. Each of them allocates a Request Context for interacting
38 * with a particular Device Context. The Request Contexts are the basic units of fairness,
39 * which is enforced by keeping a cap on the number of outstanding requests a particular Request
40 * Context can have at any point in time. Should this quota be exceeded, any further attempt to make
41 * a request to the switch will fail immediately, with proper error indication.
43 public interface DeviceContext extends
49 ContextChainStateListener {
52 * Method close all auxiliary connections and primary connection.
54 void shutdownConnection();
57 * Method add auxiliary connection contexts to this context representing single device connection.
58 * @param connectionContext new connection context
60 void addAuxiliaryConnectionContext(ConnectionContext connectionContext);
63 * Method removes auxiliary connection context from this context representing single device connection.
64 * @param connectionContext connection which need to be removed
66 void removeAuxiliaryConnectionContext(ConnectionContext connectionContext);
69 * Method provides state of device represented by this device context.
71 * @return {@link DeviceState}
73 DeviceState getDeviceState();
76 * Method has to close TxManager ASAP we are notified about Closed Connection.
77 * @return sync. future for Slave and MD-SAL completition for Master
79 ListenableFuture<Void> shuttingDownDataStoreTransactions();
83 * @return current devices connection context
85 ConnectionContext getPrimaryConnectionContext();
89 * @return current devices auxiliary connection contexts
91 ConnectionContext getAuxiliaryConnectionContexts(BigInteger cookie);
96 * @return translator library
98 TranslatorLibrary oook();
101 * store cancellable timeout handler of currently running barrier task.
103 void setCurrentBarrierTimeout(Timeout timeout);
107 * @return cancellable timeout handle of currently running barrier task
109 Timeout getBarrierTaskTimeout();
111 void setNotificationPublishService(NotificationPublishService notificationPublishService);
113 MessageSpy getMessageSpy();
115 <T extends OfHeader> MultiMsgCollector<T> getMultiMsgCollector(final RequestContext<List<T>> requestContext);
118 * indicates that device context is fully published (e.g.: packetIn messages should be passed).
123 * change packetIn rate limiter borders.
124 * @param upperBound max amount of outstanding packetIns
126 void updatePacketInRateLimit(long upperBound);
130 * @return registry point for item life cycle sources of device
132 ItemLifeCycleRegistry getItemLifeCycleSourceRegistry();
134 void setSwitchFeaturesMandatory(boolean switchFeaturesMandatory);
136 boolean isSkipTableFeatures();
139 * Setter for sal role service.
140 * @param salRoleService Role Service
142 void setSalRoleService(@Nonnull final SalRoleService salRoleService);
146 * @return listenable future from sal role service
148 ListenableFuture<RpcResult<SetRoleOutput>> makeDeviceSlave();
150 boolean canUseSingleLayerSerialization();