Package org.somda.sdc.glue.consumer

Interface SdcRemoteDevice

All Superinterfaces:

com.google.common.util.concurrent.Service

All Known Implementing Classes:

SdcRemoteDeviceImpl

public interface SdcRemoteDevice
extends com.google.common.util.concurrent.Service

SDC consumer device interface.

The purpose of SdcRemoteDevice is to receive SDC data from the network.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Method Summary

Modifier and Type	Method	Description
HostingServiceProxy	getHostingServiceProxy()	Gets the hosting service proxy.
MdibAccess	getMdibAccess()	Read access to the remote MDIB.
MdibAccessObservable	getMdibAccessObservable()	Gets an interface to subscribe for MDIB updates.
SetServiceAccess	getSetServiceAccess()	Gets a set service invoker access.
void	registerWatchdogObserver(WatchdogObserver watchdogObserver)	In order to get notified on disconnect events, this function attaches a watchdog observer.
void	unregisterWatchdogObserver(WatchdogObserver watchdogObserver)	Removes a watchdog observer.

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Method Detail

getHostingServiceProxy

HostingServiceProxy getHostingServiceProxy()

Gets the hosting service proxy.

The hosting service proxy can be used to access the device including metadata and services.

Returns:

the hosting service proxy bundled with the SDC remote device instance.

getMdibAccess

MdibAccess getMdibAccess()

Read access to the remote MDIB.

The remote MDIB is updated by a background process that processes incoming reports. In order to manually access Web Services, one can use getHostingServiceProxy().

Returns:

MDIB access to read the remote MDIB.

getMdibAccessObservable

MdibAccessObservable getMdibAccessObservable()

Gets an interface to subscribe for MDIB updates.

Returns:

the MDIB observable interface.

getSetServiceAccess

SetServiceAccess getSetServiceAccess()

Gets a set service invoker access.

Please note that the set service access only works if the context and/or set service are available from the remote device. If not set service exists, any call to the SetServiceAccess interface results in an immediately cancelled future.

Returns:

a set service invoker access interface.

See Also:

SetServiceAccess.invoke(AbstractSet, Class), SetServiceAccess.invoke(AbstractSet, Consumer, Class)

registerWatchdogObserver

void registerWatchdogObserver(WatchdogObserver watchdogObserver)

In order to get notified on disconnect events, this function attaches a watchdog observer.

Parameters:

watchdogObserver - the watchdog callback interface.

unregisterWatchdogObserver

void unregisterWatchdogObserver(WatchdogObserver watchdogObserver)

Removes a watchdog observer.

Parameters:

watchdogObserver - the watchdog observer to remove.