Package org.opendaylight.openflowjava.protocol.spi.connection

Interface SwitchConnectionProvider

All Superinterfaces:

AutoCloseable, DeserializerExtensionProvider, SerializerExtensionProvider

All Known Implementing Classes:

SwitchConnectionProviderImpl

public interface SwitchConnectionProvider
extends AutoCloseable, SerializerExtensionProvider, DeserializerExtensionProvider

Provides handling for a switch connection.

Author:

mirehak, michal.polkorab

Method Summary

Modifier and Type	Method	Description
ConnectionConfiguration	getConfiguration()	Returns the connection configuration.
void	setSwitchConnectionHandler(SwitchConnectionHandler switchConHandler)	Sets the SwitchConnectionHandler.
com.google.common.util.concurrent.ListenableFuture<Boolean>	shutdown()	Stop listening to switches.
com.google.common.util.concurrent.ListenableFuture<Boolean>	startup()	Start listening to switches, but please don't forget to do setSwitchConnectionHandler(SwitchConnectionHandler) first.

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerExtensionProvider

registerActionDeserializer, registerDeserializer, registerDeserializerMapping, registerErrorDeserializer, registerExperimenterMessageDeserializer, registerInstructionDeserializer, registerMatchEntryDeserializer, registerMeterBandDeserializer, registerMultipartReplyMessageDeserializer, registerMultipartReplyTFDeserializer, registerQueuePropertyDeserializer, unregisterDeserializer, unregisterDeserializerMapping

Methods inherited from interface org.opendaylight.openflowjava.protocol.api.extensibility.SerializerExtensionProvider

registerActionSerializer, registerExperimenterMessageSerializer, registerInstructionSerializer, registerMatchEntrySerializer, registerMeterBandSerializer, registerMeterBandSerializer, registerMultipartRequestSerializer, registerMultipartRequestTFSerializer, registerSerializer, unregisterSerializer

Method Detail

getConfiguration

ConnectionConfiguration getConfiguration()

Returns the connection configuration.

Returns:

configuration [protocol, port, address and supported features]

startup

com.google.common.util.concurrent.ListenableFuture<Boolean> startup()

Start listening to switches, but please don't forget to do setSwitchConnectionHandler(SwitchConnectionHandler) first.

Returns:

future, triggered to true, when listening channel is up and running

shutdown

com.google.common.util.concurrent.ListenableFuture<Boolean> shutdown()

Stop listening to switches.

Returns:

future, triggered to true, when all listening channels are down

setSwitchConnectionHandler

void setSwitchConnectionHandler(SwitchConnectionHandler switchConHandler)

Sets the SwitchConnectionHandler.

Parameters:

switchConHandler - instance being informed when new switch connects