2 * Copyright (c) 2013 Pantheon Technologies s.r.o. 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
10 package org.opendaylight.openflowjava.protocol.impl.core.connection;
12 import com.google.common.base.Preconditions;
13 import io.netty.channel.Channel;
14 import java.net.InetSocketAddress;
15 import org.opendaylight.openflowjava.protocol.api.connection.ConnectionReadyListener;
16 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandler;
17 import org.opendaylight.openflowjava.protocol.api.connection.OutboundQueueHandlerRegistration;
18 import org.opendaylight.openflowjava.protocol.impl.core.OFVersionDetector;
19 import org.opendaylight.openflowjava.protocol.impl.core.PipelineHandlers;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.EchoRequestMessage;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ErrorMessage;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.ExperimenterMessage;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.FlowRemovedMessage;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.HelloMessage;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OfHeader;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PacketInMessage;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.PortStatusMessage;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.DisconnectEvent;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SwitchIdleEvent;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SystemNotificationsListener;
33 import org.opendaylight.yangtools.yang.binding.DataObject;
34 import org.opendaylight.yangtools.yang.binding.Notification;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
39 * Handles messages (notifications + rpcs) and connections
41 * @author michal.polkorab
43 public class ConnectionAdapterImpl extends AbstractConnectionAdapterStatistics implements ConnectionFacade {
45 private static final Logger LOG = LoggerFactory.getLogger(ConnectionAdapterImpl.class);
47 private ConnectionReadyListener connectionReadyListener;
48 private OpenflowProtocolListener messageListener;
49 private SystemNotificationsListener systemListener;
50 private AbstractOutboundQueueManager<?, ?> outputManager;
51 private OFVersionDetector versionDetector;
53 private final boolean useBarrier;
58 * @param channel the channel to be set - used for communication
59 * @param address client address (used only in case of UDP communication,
60 * as there is no need to store address over tcp (stable channel))
61 * @param useBarrier value is configurable by configSubsytem
63 public ConnectionAdapterImpl(final Channel channel, final InetSocketAddress address, final boolean useBarrier) {
64 super(channel, address);
65 this.useBarrier = useBarrier;
66 LOG.debug("ConnectionAdapter created");
70 public void setMessageListener(final OpenflowProtocolListener messageListener) {
71 this.messageListener = messageListener;
75 public void setConnectionReadyListener(final ConnectionReadyListener connectionReadyListener) {
76 this.connectionReadyListener = connectionReadyListener;
80 public void setSystemListener(final SystemNotificationsListener systemListener) {
81 this.systemListener = systemListener;
85 public void consumeDeviceMessage(final DataObject message) {
86 LOG.debug("ConsumeIntern msg on {}", channel);
87 if (disconnectOccured ) {
90 if (message instanceof Notification) {
93 if (message instanceof DisconnectEvent) {
94 systemListener.onDisconnectEvent((DisconnectEvent) message);
95 responseCache.invalidateAll();
96 disconnectOccured = true;
97 } else if (message instanceof SwitchIdleEvent) {
98 systemListener.onSwitchIdleEvent((SwitchIdleEvent) message);
100 } else if (message instanceof EchoRequestMessage) {
101 if (outputManager != null) {
102 outputManager.onEchoRequest((EchoRequestMessage) message);
104 messageListener.onEchoRequestMessage((EchoRequestMessage) message);
106 } else if (message instanceof ErrorMessage) {
107 // Send only unmatched errors
108 if (outputManager == null || !outputManager.onMessage((OfHeader) message)) {
109 messageListener.onErrorMessage((ErrorMessage) message);
111 } else if (message instanceof ExperimenterMessage) {
112 if (outputManager != null) {
113 outputManager.onMessage((OfHeader) message);
115 messageListener.onExperimenterMessage((ExperimenterMessage) message);
116 } else if (message instanceof FlowRemovedMessage) {
117 messageListener.onFlowRemovedMessage((FlowRemovedMessage) message);
118 } else if (message instanceof HelloMessage) {
119 LOG.info("Hello received / branch");
120 messageListener.onHelloMessage((HelloMessage) message);
121 } else if (message instanceof MultipartReplyMessage) {
122 if (outputManager != null) {
123 outputManager.onMessage((OfHeader) message);
125 messageListener.onMultipartReplyMessage((MultipartReplyMessage) message);
126 } else if (message instanceof PacketInMessage) {
127 messageListener.onPacketInMessage((PacketInMessage) message);
128 } else if (message instanceof PortStatusMessage) {
129 messageListener.onPortStatusMessage((PortStatusMessage) message);
131 LOG.warn("message listening not supported for type: {}", message.getClass());
133 } else if (message instanceof OfHeader) {
134 LOG.debug("OFheader msg received");
136 if (outputManager == null || !outputManager.onMessage((OfHeader) message)) {
137 final RpcResponseKey key = createRpcResponseKey((OfHeader) message);
138 final ResponseExpectedRpcListener<?> listener = findRpcResponse(key);
139 if (listener != null) {
140 LOG.debug("corresponding rpcFuture found");
141 listener.completed((OfHeader)message);
142 LOG.debug("after setting rpcFuture");
143 responseCache.invalidate(key);
145 LOG.warn("received unexpected rpc response: {}", key);
149 LOG.warn("message listening not supported for type: {}", message.getClass());
157 private static RpcResponseKey createRpcResponseKey(final OfHeader message) {
158 return new RpcResponseKey(message.getXid(), message.getImplementedInterface().getName());
162 public void checkListeners() {
163 final StringBuilder buffer = new StringBuilder();
164 if (systemListener == null) {
165 buffer.append("SystemListener ");
167 if (messageListener == null) {
168 buffer.append("MessageListener ");
170 if (connectionReadyListener == null) {
171 buffer.append("ConnectionReadyListener ");
174 Preconditions.checkState(buffer.length() == 0, "Missing listeners: %s", buffer.toString());
178 public void fireConnectionReadyNotification() {
179 versionDetector = (OFVersionDetector) channel.pipeline().get(PipelineHandlers.OF_VERSION_DETECTOR.name());
180 Preconditions.checkState(versionDetector != null);
182 new Thread(new Runnable() {
185 connectionReadyListener.onConnectionReady();
191 public <T extends OutboundQueueHandler> OutboundQueueHandlerRegistration<T> registerOutboundQueueHandler(
192 final T handler, final int maxQueueDepth, final long maxBarrierNanos) {
193 Preconditions.checkState(outputManager == null, "Manager %s already registered", outputManager);
195 final AbstractOutboundQueueManager<T, ?> ret;
197 ret = new OutboundQueueManager<>(this, address, handler, maxQueueDepth, maxBarrierNanos);
199 LOG.warn("OutboundQueueManager without barrier is started.");
200 ret = new OutboundQueueManagerNoBarrier<>(this, address, handler);
204 /* we don't need it anymore */
205 channel.pipeline().remove(output);
206 // OutboundQueueManager is put before DelegatingInboundHandler because otherwise channelInactive event would
207 // be first processed in OutboundQueueManager and then in ConnectionAdapter (and Openflowplugin). This might
208 // cause problems because we are shutting down the queue before Openflowplugin knows about it.
209 channel.pipeline().addBefore(PipelineHandlers.DELEGATING_INBOUND_HANDLER.name(),
210 PipelineHandlers.CHANNEL_OUTBOUND_QUEUE_MANAGER.name(), outputManager);
212 return new OutboundQueueHandlerRegistrationImpl<T>(handler) {
214 protected void removeRegistration() {
215 outputManager.close();
216 channel.pipeline().remove(outputManager);
217 outputManager = null;
222 Channel getChannel() {
227 public void setPacketInFiltering(final boolean enabled) {
228 versionDetector.setFilterPacketIns(enabled);
229 LOG.debug("PacketIn filtering {}abled", enabled ? "en" : "dis");