org.opendaylight.ocpjava.protocol.api.connection

Interface ConnectionAdapter

All Superinterfaces:

OcpExtensionService, OcpProtocolService, RpcService

public interface ConnectionAdapter
extends OcpProtocolService, OcpExtensionService

Author:

Marko Lai

Method Summary

Modifier and Type	Method and Description
void	checkListeners() Throws exception if any of required listeners is missing
Future<Boolean>	disconnect() disconnect corresponding RRH
void	fireConnectionReadyNotification() notify listener about connection ready-to-use event
InetSocketAddress	getRemoteAddress()
boolean	isAlive()
boolean	isAutoRead()
<T extends OutboundQueueHandler> OutboundQueueHandlerRegistration<T>	registerOutboundQueueHandler(T handler, int maxQueueDepth) Registers a new bypass outbound queue
void	setAutoRead(boolean autoRead) sets option for automatic channel reading; if set to false, incoming messages won't be read
void	setConnectionReadyListener(ConnectionReadyListener connectionReadyListener) set listener for connection became ready-to-use event
void	setIdleTimeout(long idleTimeout) marko.lai added, 2015/11/11 sets option for idle timeout millisecond;
void	setMessageExtListener(OcpExtensionListener messageExtListener) marko.lai added for OCP extension Indication, 2015/07/29
void	setMessageListener(OcpProtocolListener messageListener)
void	setSystemListener(SystemNotificationsListener systemListener)

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.protocol.rev150811.OcpProtocolService

createObj, deleteObj, getFault, getParam, getState, healthCheck, modifyParam, modifyState, reReset, setTime

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.ocp.extension.rev150811.OcpExtensionService

hello, reDirect

Method Detail

disconnect

Future<Boolean> disconnect()

disconnect corresponding RRH

Returns:

future set to true, when disconnect completed

isAlive

boolean isAlive()

Returns:

true, if connection to RRH is alive

getRemoteAddress

InetSocketAddress getRemoteAddress()

Returns:

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

setMessageListener

void setMessageListener(OcpProtocolListener messageListener)

Parameters:

messageListener - here will be pushed all messages from RRH

setMessageExtListener

void setMessageExtListener(OcpExtensionListener messageExtListener)

marko.lai added for OCP extension Indication, 2015/07/29

Parameters:

messageListener - here will be pushed all messages from RRH

setSystemListener

void setSystemListener(SystemNotificationsListener systemListener)

Parameters:

systemListener - here will be pushed all system messages from library

checkListeners

void checkListeners()

Throws exception if any of required listeners is missing

fireConnectionReadyNotification

void fireConnectionReadyNotification()

notify listener about connection ready-to-use event

setConnectionReadyListener

void setConnectionReadyListener(ConnectionReadyListener connectionReadyListener)

set listener for connection became ready-to-use event

Parameters:

connectionReadyListener -

setAutoRead

void setAutoRead(boolean autoRead)

sets option for automatic channel reading; if set to false, incoming messages won't be read

isAutoRead

boolean isAutoRead()

Returns:

true, if channel is configured to autoread

setIdleTimeout

void setIdleTimeout(long idleTimeout)

marko.lai added, 2015/11/11 sets option for idle timeout millisecond;

registerOutboundQueueHandler

@Beta
<T extends OutboundQueueHandler> OutboundQueueHandlerRegistration<T> registerOutboundQueueHandler(T handler,
                                                                                                        int maxQueueDepth)

Registers a new bypass outbound queue

Parameters:

handler -

maxQueueDepth -

Returns:

An OutboundQueueHandlerRegistration