org.opendaylight.ocpjava.protocol.impl.core.connection

Class ConnectionAdapterImpl

java.lang.Object

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

All Implemented Interfaces:

org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter, ConnectionFacade, MessageConsumer, org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.OcpExtensionService, org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService, org.opendaylight.yangtools.yang.binding.RpcService

public class ConnectionAdapterImpl
extends Object
implements ConnectionFacade

Handles messages (notifications + rpcs) and connections

Author:

mirehak, michal.polkorab, Marko Lai

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_QUEUE_DEPTH Default depth of write queue, e.g.
static int	RPC_RESPONSE_EXPIRATION after this time, RPC future response objects will be thrown away (in minutes)

Constructor Summary

Constructors

Constructor and Description
ConnectionAdapterImpl(io.netty.channel.Channel channel, InetSocketAddress address) default ctor

Method Summary

Modifier and Type	Method and Description
void	checkListeners()
void	consume(org.opendaylight.yangtools.yang.binding.DataObject message)
Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.CreateObjOutput>>	createObj(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.CreateObjInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.DeleteObjOutput>>	deleteObj(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.DeleteObjInput input)
Future<Boolean>	disconnect()
void	fireConnectionReadyNotification()
Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetFaultOutput>>	getFault(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetFaultInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetParamOutput>>	getParam(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetParamInput input)
InetSocketAddress	getRemoteAddress()
Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetStateOutput>>	getState(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetStateInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.HealthCheckOutput>>	healthCheck(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.HealthCheckInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>>	hello(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.HelloInput input)
boolean	isAlive()
boolean	isAutoRead()
Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ModifyParamOutput>>	modifyParam(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ModifyParamInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ModifyStateOutput>>	modifyState(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ModifyStateInput input)
Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.ReDirectOutput>>	reDirect(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.ReDirectInput input)
<T extends org.opendaylight.ocpjava.protocol.api.connection.OutboundQueueHandler> org.opendaylight.ocpjava.protocol.api.connection.OutboundQueueHandlerRegistration<T>	registerOutboundQueueHandler(T handler, int maxQueueDepth)
Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ReResetOutput>>	reReset(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ReResetInput input)
void	setAutoRead(boolean autoRead)
void	setConnectionReadyListener(org.opendaylight.ocpjava.protocol.api.connection.ConnectionReadyListener connectionReadyListener)
void	setIdleTimeout(long idleTimeout)
void	setMessageExtListener(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.OcpExtensionListener messageExtListener)
void	setMessageListener(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolListener messageListener)
void	setResponseCache(com.google.common.cache.Cache<RpcResponseKey,org.opendaylight.ocpjava.protocol.impl.core.connection.ResponseExpectedRpcListener<?>> cache) Used only for testing purposes
void	setSystemListener(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.system.rev150811.SystemNotificationsListener systemListener)
Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.SetTimeOutput>>	setTime(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.SetTimeInput input)

Methods inherited from class java.lang.Object

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

Field Detail

RPC_RESPONSE_EXPIRATION

public static final int RPC_RESPONSE_EXPIRATION

after this time, RPC future response objects will be thrown away (in minutes)

See Also:

Constant Field Values

DEFAULT_QUEUE_DEPTH

public static final int DEFAULT_QUEUE_DEPTH

Default depth of write queue, e.g. we allow these many messages to be queued up before blocking producers.

See Also:

Constant Field Values

Constructor Detail

ConnectionAdapterImpl

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

default ctor

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))

Method Detail

healthCheck

public Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.HealthCheckOutput>> healthCheck(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.HealthCheckInput input)

Specified by:

healthCheck in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService

setTime

public Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.SetTimeOutput>> setTime(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.SetTimeInput input)

Specified by:

setTime in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService

reReset

public Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ReResetOutput>> reReset(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ReResetInput input)

Specified by:

reReset in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService

getParam

public Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetParamOutput>> getParam(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetParamInput input)

Specified by:

getParam in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService

modifyParam

public Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ModifyParamOutput>> modifyParam(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ModifyParamInput input)

Specified by:

modifyParam in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService

createObj

public Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.CreateObjOutput>> createObj(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.CreateObjInput input)

Specified by:

createObj in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService

deleteObj

public Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.DeleteObjOutput>> deleteObj(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.DeleteObjInput input)

Specified by:

deleteObj in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService

getState

public Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetStateOutput>> getState(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetStateInput input)

Specified by:

getState in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService

modifyState

public Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ModifyStateOutput>> modifyState(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.ModifyStateInput input)

Specified by:

modifyState in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService

getFault

public Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetFaultOutput>> getFault(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.GetFaultInput input)

Specified by:

getFault in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService

reDirect

public Future<org.opendaylight.yangtools.yang.common.RpcResult<org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.ReDirectOutput>> reDirect(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.ReDirectInput input)

Specified by:

reDirect in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.OcpExtensionService

hello

public Future<org.opendaylight.yangtools.yang.common.RpcResult<Void>> hello(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.HelloInput input)

Specified by:

hello in interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.OcpExtensionService

disconnect

public Future<Boolean> disconnect()

Specified by:

disconnect in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

isAlive

public boolean isAlive()

Specified by:

isAlive in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

setMessageListener

public void setMessageListener(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolListener messageListener)

Specified by:

setMessageListener in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

setMessageExtListener

public void setMessageExtListener(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.OcpExtensionListener messageExtListener)

Specified by:

setMessageExtListener in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

consume

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

Specified by:

consume in interface MessageConsumer

Parameters:

message - to process

setSystemListener

public void setSystemListener(org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.system.rev150811.SystemNotificationsListener systemListener)

Specified by:

setSystemListener in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

checkListeners

public void checkListeners()

Specified by:

checkListeners in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

fireConnectionReadyNotification

public void fireConnectionReadyNotification()

Specified by:

fireConnectionReadyNotification in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

setConnectionReadyListener

public void setConnectionReadyListener(org.opendaylight.ocpjava.protocol.api.connection.ConnectionReadyListener connectionReadyListener)

Specified by:

setConnectionReadyListener in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

getRemoteAddress

public InetSocketAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

setResponseCache

public void setResponseCache(com.google.common.cache.Cache<RpcResponseKey,org.opendaylight.ocpjava.protocol.impl.core.connection.ResponseExpectedRpcListener<?>> cache)

Used only for testing purposes

Parameters:

cache -

isAutoRead

public boolean isAutoRead()

Specified by:

isAutoRead in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

setAutoRead

public void setAutoRead(boolean autoRead)

Specified by:

setAutoRead in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

setIdleTimeout

public void setIdleTimeout(long idleTimeout)

Specified by:

setIdleTimeout in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter

registerOutboundQueueHandler

public <T extends org.opendaylight.ocpjava.protocol.api.connection.OutboundQueueHandler> org.opendaylight.ocpjava.protocol.api.connection.OutboundQueueHandlerRegistration<T> registerOutboundQueueHandler(T handler,
                                                                                                                                                                                                           int maxQueueDepth)

Specified by:

registerOutboundQueueHandler in interface org.opendaylight.ocpjava.protocol.api.connection.ConnectionAdapter