org.opendaylight.openflowjava.protocol.impl.core.connection

Class ConnectionAdapterImpl

java.lang.Object

org.opendaylight.openflowjava.protocol.impl.core.connection.ConnectionAdapterImpl

All Implemented Interfaces:

ConnectionAdapter, ConnectionFacade, MessageConsumer, OpenflowProtocolService, org.opendaylight.yangtools.yang.binding.RpcService

public class ConnectionAdapterImpl
extends Object
implements ConnectionFacade

Handles messages (notifications + rpcs) and connections.

Author:

mirehak, michal.polkorab

Field Summary

Fields

Modifier and Type	Field and Description
protected InetSocketAddress	address
protected io.netty.channel.Channel	channel
protected boolean	disconnectOccured
protected org.opendaylight.openflowjava.protocol.impl.core.connection.ChannelOutboundQueue	output
protected static com.google.common.cache.RemovalListener<RpcResponseKey,org.opendaylight.openflowjava.protocol.impl.core.connection.ResponseExpectedRpcListener<?>>	REMOVAL_LISTENER
protected com.google.common.cache.Cache<RpcResponseKey,org.opendaylight.openflowjava.protocol.impl.core.connection.ResponseExpectedRpcListener<?>>	responseCache expiring cache for future rpcResponses.

Constructor Summary

Constructors

Constructor and Description
ConnectionAdapterImpl(io.netty.channel.Channel channel, InetSocketAddress address, boolean useBarrier) Default constructor.

Method Summary

Modifier and Type	Method and Description
Future<org.opendaylight.yangtools.yang.common.RpcResult<BarrierOutput>>	barrier(BarrierInput input)
void	checkListeners() Throws exception if any of required listeners is missing.
void	consume(org.opendaylight.yangtools.yang.binding.DataObject message) Invoked to consume a message.
void	consumeDeviceMessage(org.opendaylight.yangtools.yang.binding.DataObject message) Method is equivalent to MessageConsumer.consume(DataObject) to prevent missing method in every children of AbstractConnectionAdapterStatistics class, because we overriding original method for StatisticsCounters.
Future<Boolean>	disconnect() Disconnect corresponding switch.
Future<org.opendaylight.yangtools.yang.common.RpcResult<EchoOutput>>	echo(EchoInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	echoReply(EchoReplyInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	experimenter(ExperimenterInput input) Send experimenter message to device, reply is not solicitated.
protected org.opendaylight.openflowjava.protocol.impl.core.connection.ResponseExpectedRpcListener<?>	findRpcResponse(RpcResponseKey key) Return cached RpcListener or null if not cached.
void	fireConnectionReadyNotification() Notify listener about connection ready-to-use event.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	flowMod(FlowModInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetAsyncOutput>>	getAsync(GetAsyncInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetConfigOutput>>	getConfig(GetConfigInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetFeaturesOutput>>	getFeatures(GetFeaturesInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<GetQueueConfigOutput>>	getQueueConfig(GetQueueConfigInput input)
InetSocketAddress	getRemoteAddress() Returns the address of the connected switch.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	groupMod(GroupModInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	hello(HelloInput input)
boolean	isAlive() Determines if the connection to the switch is alive.
boolean	isAutoRead() Determines if the channel is configured to auto-read.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	meterMod(MeterModInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	multipartRequest(MultipartRequestInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	packetOut(PacketOutInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	portMod(PortModInput input)
<T extends OutboundQueueHandler> OutboundQueueHandlerRegistration<T>	registerOutboundQueueHandler(T handler, int maxQueueDepth, long maxBarrierNanos) Registers a new bypass outbound queue.
Future<org.opendaylight.yangtools.yang.common.RpcResult<RoleRequestOutput>>	roleRequest(RoleRequestInput input)
protected <I extends OfHeader,O extends OfHeader> com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<O>>	sendToSwitchExpectRpcResultFuture(I input, Class<O> responseClazz, String failureInfo) Sends given message to switch, sending result or switch response will be reported via return value.
protected com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	sendToSwitchFuture(org.opendaylight.yangtools.yang.binding.DataObject input, String failureInfo) Sends given message to switch, sending result will be reported via return value.
void	setAlienMessageListener(AlienMessageListener alienMessageListener) Set handler for alien messages received from device.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	setAsync(SetAsyncInput input)
void	setAutoRead(boolean autoRead) Sets option for automatic channel reading - if set to false, incoming messages won't be read.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	setConfig(SetConfigInput input)
void	setConnectionReadyListener(ConnectionReadyListener connectionReadyListener) Set listener for connection became ready-to-use event.
void	setMessageListener(OpenflowProtocolListener messageListener) Sets the protocol message listener.
void	setPacketInFiltering(boolean enabled) Set filtering of PacketIn messages.
void	setSystemListener(SystemNotificationsListener systemListener) Sets the system message listener.
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	tableMod(TableModInput input)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opendaylight.openflowjava.protocol.impl.core.connection.MessageConsumer

consume

Methods inherited from interface org.opendaylight.openflowjava.protocol.api.connection.ConnectionAdapter

disconnect, getRemoteAddress, isAlive, isAutoRead, setAutoRead

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.OpenflowProtocolService

barrier, echo, echoReply, experimenter, flowMod, getAsync, getConfig, getFeatures, getQueueConfig, groupMod, hello, meterMod, multipartRequest, packetOut, portMod, roleRequest, setAsync, setConfig, tableMod

Field Detail

REMOVAL_LISTENER

protected static final com.google.common.cache.RemovalListener<RpcResponseKey,org.opendaylight.openflowjava.protocol.impl.core.connection.ResponseExpectedRpcListener<?>> REMOVAL_LISTENER

channel

protected final io.netty.channel.Channel channel

address

protected final InetSocketAddress address

disconnectOccured

protected boolean disconnectOccured

output

protected final org.opendaylight.openflowjava.protocol.impl.core.connection.ChannelOutboundQueue output

responseCache

protected com.google.common.cache.Cache<RpcResponseKey,org.opendaylight.openflowjava.protocol.impl.core.connection.ResponseExpectedRpcListener<?>> responseCache

expiring cache for future rpcResponses.

Constructor Detail

ConnectionAdapterImpl

public ConnectionAdapterImpl(io.netty.channel.Channel channel,
                             InetSocketAddress address,
                             boolean useBarrier)

Default constructor.

Parameters:

channel - the channel to be set - used for communication

address - client address (used only in case of UDP communication, as there is no need to store address over tcp (stable channel))

useBarrier - value is configurable by configSubsytem

Method Detail

setMessageListener

public void setMessageListener(OpenflowProtocolListener messageListener)

Description copied from interface: ConnectionAdapter

Sets the protocol message listener.

Specified by:

setMessageListener in interface ConnectionAdapter

Parameters:

messageListener - here will be pushed all messages from switch

setConnectionReadyListener

public void setConnectionReadyListener(ConnectionReadyListener connectionReadyListener)

Description copied from interface: ConnectionAdapter

Set listener for connection became ready-to-use event.

Specified by:

setConnectionReadyListener in interface ConnectionAdapter

Parameters:

connectionReadyListener - listens to connection ready event

setSystemListener

public void setSystemListener(SystemNotificationsListener systemListener)

Description copied from interface: ConnectionAdapter

Sets the system message listener.

Specified by:

setSystemListener in interface ConnectionAdapter

Parameters:

systemListener - here will be pushed all system messages from library

setAlienMessageListener

public void setAlienMessageListener(AlienMessageListener alienMessageListener)

Description copied from interface: ConnectionAdapter

Set handler for alien messages received from device.

Specified by:

setAlienMessageListener in interface ConnectionAdapter

Parameters:

alienMessageListener - here will be pushed all alien messages from switch

consumeDeviceMessage

public void consumeDeviceMessage(org.opendaylight.yangtools.yang.binding.DataObject message)

Method is equivalent to MessageConsumer.consume(DataObject) to prevent missing method in every children of AbstractConnectionAdapterStatistics class, because we overriding original method for StatisticsCounters.

Parameters:

message - from device to processing

checkListeners

public void checkListeners()

Description copied from interface: ConnectionAdapter

Throws exception if any of required listeners is missing.

Specified by:

checkListeners in interface ConnectionAdapter

fireConnectionReadyNotification

public void fireConnectionReadyNotification()

Description copied from interface: ConnectionAdapter

Notify listener about connection ready-to-use event.

Specified by:

fireConnectionReadyNotification in interface ConnectionAdapter

registerOutboundQueueHandler

public <T extends OutboundQueueHandler> OutboundQueueHandlerRegistration<T> registerOutboundQueueHandler(T handler,
                                                                                                         int maxQueueDepth,
                                                                                                         long maxBarrierNanos)

Description copied from interface: ConnectionAdapter

Registers a new bypass outbound queue.

Specified by:

registerOutboundQueueHandler in interface ConnectionAdapter

Type Parameters:

T - handler type

Parameters:

handler - queue handler

maxQueueDepth - max amount of not confirmed messaged in queue (i.e. edge for barrier message)

maxBarrierNanos - regular base for barrier message

Returns:

An OutboundQueueHandlerRegistration

setPacketInFiltering

public void setPacketInFiltering(boolean enabled)

Description copied from interface: ConnectionAdapter

Set filtering of PacketIn messages. By default these messages are not filtered.

Specified by:

setPacketInFiltering in interface ConnectionAdapter

Parameters:

enabled - True if PacketIn messages should be filtered, false if they should be reported.

flowMod

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> flowMod(FlowModInput input)

Specified by:

flowMod in interface OpenflowProtocolService

sendToSwitchExpectRpcResultFuture

protected <I extends OfHeader,O extends OfHeader> com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<O>> sendToSwitchExpectRpcResultFuture(I input,
                                                                                                                                                                                            Class<O> responseClazz,
                                                                                                                                                                                            String failureInfo)

Sends given message to switch, sending result or switch response will be reported via return value.

Parameters:

input - message to send

responseClazz - type of response

failureInfo - describes, what type of message caused failure by sending

Returns:

future object,

• if send fails, RpcResult will contain errors and failed status
• else RpcResult will be stored in responseCache and wait for particular timeout ( AbstractConnectionAdapter.RPC_RESPONSE_EXPIRATION),
  • either switch will manage to answer and then corresponding response message will be set into returned future
  • or response in cache will expire and returned future will be cancelled

sendToSwitchFuture

protected com.google.common.util.concurrent.ListenableFuture<org.opendaylight.yangtools.yang.common.RpcResult<Void>> sendToSwitchFuture(org.opendaylight.yangtools.yang.binding.DataObject input,
                                                                                                                                        String failureInfo)

Sends given message to switch, sending result will be reported via return value.

Parameters:

input - message to send

failureInfo - describes, what type of message caused failure by sending

Returns:

future object,

• if send successful, RpcResult without errors and successful status will be returned,
• else RpcResult will contain errors and failed status

consume

public void consume(org.opendaylight.yangtools.yang.binding.DataObject message)

Description copied from interface: MessageConsumer

Invoked to consume a message.

Specified by:

consume in interface MessageConsumer

Parameters:

message - to process

disconnect

public Future<Boolean> disconnect()

Description copied from interface: ConnectionAdapter

Disconnect corresponding switch.

Specified by:

disconnect in interface ConnectionAdapter

Returns:

future set to true, when disconnect completed

barrier

public Future<org.opendaylight.yangtools.yang.common.RpcResult<BarrierOutput>> barrier(BarrierInput input)

Specified by:

barrier in interface OpenflowProtocolService

echo

public Future<org.opendaylight.yangtools.yang.common.RpcResult<EchoOutput>> echo(EchoInput input)

Specified by:

echo in interface OpenflowProtocolService

echoReply

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> echoReply(EchoReplyInput input)

Specified by:

echoReply in interface OpenflowProtocolService

experimenter

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> experimenter(ExperimenterInput input)

Description copied from interface: OpenflowProtocolService

Send experimenter message to device, reply is not solicitated.

Specified by:

experimenter in interface OpenflowProtocolService

getConfig

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetConfigOutput>> getConfig(GetConfigInput input)

Specified by:

getConfig in interface OpenflowProtocolService

Returns:

java.util.concurrent.Future config, or null if not present

getFeatures

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetFeaturesOutput>> getFeatures(GetFeaturesInput input)

Specified by:

getFeatures in interface OpenflowProtocolService

Returns:

java.util.concurrent.Future features, or null if not present

getQueueConfig

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetQueueConfigOutput>> getQueueConfig(GetQueueConfigInput input)

Specified by:

getQueueConfig in interface OpenflowProtocolService

Returns:

java.util.concurrent.Future queueConfig, or null if not present

groupMod

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> groupMod(GroupModInput input)

Specified by:

groupMod in interface OpenflowProtocolService

hello

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> hello(HelloInput input)

Specified by:

hello in interface OpenflowProtocolService

meterMod

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> meterMod(MeterModInput input)

Specified by:

meterMod in interface OpenflowProtocolService

packetOut

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> packetOut(PacketOutInput input)

Specified by:

packetOut in interface OpenflowProtocolService

multipartRequest

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> multipartRequest(MultipartRequestInput input)

Specified by:

multipartRequest in interface OpenflowProtocolService

portMod

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> portMod(PortModInput input)

Specified by:

portMod in interface OpenflowProtocolService

roleRequest

public Future<org.opendaylight.yangtools.yang.common.RpcResult<RoleRequestOutput>> roleRequest(RoleRequestInput input)

Specified by:

roleRequest in interface OpenflowProtocolService

setConfig

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> setConfig(SetConfigInput input)

Specified by:

setConfig in interface OpenflowProtocolService

tableMod

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> tableMod(TableModInput input)

Specified by:

tableMod in interface OpenflowProtocolService

getAsync

public Future<org.opendaylight.yangtools.yang.common.RpcResult<GetAsyncOutput>> getAsync(GetAsyncInput input)

Specified by:

getAsync in interface OpenflowProtocolService

Returns:

java.util.concurrent.Future async, or null if not present

setAsync

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> setAsync(SetAsyncInput input)

Specified by:

setAsync in interface OpenflowProtocolService

isAlive

public boolean isAlive()

Description copied from interface: ConnectionAdapter

Determines if the connection to the switch is alive.

Specified by:

isAlive in interface ConnectionAdapter

Returns:

true, if connection to switch is alive

isAutoRead

public boolean isAutoRead()

Description copied from interface: ConnectionAdapter

Determines if the channel is configured to auto-read.

Specified by:

isAutoRead in interface ConnectionAdapter

Returns:

true, if channel is configured to auto-read

setAutoRead

public void setAutoRead(boolean autoRead)

Description copied from interface: ConnectionAdapter

Sets option for automatic channel reading - if set to false, incoming messages won't be read.

Specified by:

setAutoRead in interface ConnectionAdapter

Parameters:

autoRead - target value to be switched to

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Description copied from interface: ConnectionAdapter

Returns the address of the connected switch.

Specified by:

getRemoteAddress in interface ConnectionAdapter

Returns:

address of the remote end - address of a switch if connected

findRpcResponse

protected org.opendaylight.openflowjava.protocol.impl.core.connection.ResponseExpectedRpcListener<?> findRpcResponse(RpcResponseKey key)

Return cached RpcListener or null if not cached.