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
8 package org.opendaylight.openflowjava.protocol.api.connection;
10 import com.google.common.annotations.Beta;
11 import java.math.BigInteger;
12 import java.net.InetSocketAddress;
13 import java.security.cert.X509Certificate;
14 import java.util.List;
15 import java.util.concurrent.ExecutorService;
16 import java.util.concurrent.Future;
17 import org.eclipse.jdt.annotation.Nullable;
18 import org.opendaylight.openflowjava.protocol.api.extensibility.AlienMessageListener;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolListener;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolService;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.system.rev130927.SystemNotificationsListener;
24 * Manages a switch connection.
27 * @author michal.polkorab
29 public interface ConnectionAdapter extends OpenflowProtocolService {
32 * Disconnect corresponding switch.
34 * @return future set to true, when disconnect completed
36 Future<Boolean> disconnect();
39 * Determines if the connection to the switch is alive.
41 * @return true, if connection to switch is alive
46 * Returns the address of the connected switch.
48 * @return address of the remote end - address of a switch if connected
50 InetSocketAddress getRemoteAddress();
53 * Sets the protocol message listener.
55 * @param messageListener here will be pushed all messages from switch
57 void setMessageListener(OpenflowProtocolListener messageListener);
60 * Sets the system message listener.
62 * @param systemListener here will be pushed all system messages from library
64 void setSystemListener(SystemNotificationsListener systemListener);
67 * Set handler for alien messages received from device.
69 * @param alienMessageListener here will be pushed all alien messages from switch
71 void setAlienMessageListener(AlienMessageListener alienMessageListener);
74 * Throws exception if any of required listeners is missing.
76 void checkListeners();
79 * Notify listener about connection ready-to-use event.
81 void fireConnectionReadyNotification();
84 * Notify listener about switch certificate information.
86 * @param certificateChain X509 certificate chain presented by the switch
88 void onSwitchCertificateIdentified(@Nullable List<X509Certificate> certificateChain);
91 * Set listener for connection became ready-to-use event.
93 * @param connectionReadyListener listens to connection ready event
95 void setConnectionReadyListener(ConnectionReadyListener connectionReadyListener);
98 * Sets option for automatic channel reading - if set to false, incoming messages won't be read.
100 * @param autoRead target value to be switched to
102 void setAutoRead(boolean autoRead);
105 * Determines if the channel is configured to auto-read.
107 * @return true, if channel is configured to auto-read
109 boolean isAutoRead();
112 * Registers a new bypass outbound queue.
114 * @param <T> handler type
115 * @param handler queue handler
116 * @param maxQueueDepth max amount of not confirmed messaged in queue (i.e. edge for barrier message)
117 * @param maxBarrierNanos regular base for barrier message
118 * @return An {@link OutboundQueueHandlerRegistration}
121 <T extends OutboundQueueHandler> OutboundQueueHandlerRegistration<T> registerOutboundQueueHandler(T handler,
122 int maxQueueDepth, long maxBarrierNanos);
125 * Set filtering of PacketIn messages. By default these messages are not filtered.
126 * @param enabled True if PacketIn messages should be filtered, false if they should be reported.
129 void setPacketInFiltering(boolean enabled);
132 * Set datapathId for the dpn.
133 * @param datapathId of the dpn
135 void setDatapathId(BigInteger datapathId);
138 * Sets executorService.
139 * @param executorService for all dpns
141 void setExecutorService(ExecutorService executorService);