org.sensorhub.api.comm

Interface ICommNetwork<ConfigType extends ModuleConfig>

Type Parameters:

ConfigType - Type of network configuration

All Superinterfaces:

IEventProducer, IModule<ConfigType>

public interface ICommNetwork<ConfigType extends ModuleConfig>
extends IModule<ConfigType>

Interface used to represent communication networks of different types, such as Ethernet, WiFi, Bluetooth, Bluetooth LE, ZigBee, etc...

Since:

Feb 9, 2016

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ICommNetwork.NetworkType

Method Summary

Modifier and Type	Method and Description
java.util.Collection<? extends INetworkInfo>	getAvailableNetworks()
IDeviceScanner	getDeviceScanner()
java.lang.String	getInterfaceName()
ICommNetwork.NetworkType	getNetworkType()
boolean	isOfType(ICommNetwork.NetworkType type) Checks if this network is compatible with given type.

Methods inherited from interface org.sensorhub.api.module.IModule

cleanup, getConfiguration, getCurrentError, getCurrentState, getLocalID, getName, getStatusMessage, init, init, isInitialized, isStarted, loadState, registerListener, requestInit, requestStart, requestStop, saveState, setConfiguration, start, stop, unregisterListener, updateConfig, waitForState

Method Detail

getInterfaceName

java.lang.String getInterfaceName()

Returns:

Name of network interface

getNetworkType

ICommNetwork.NetworkType getNetworkType()

Returns:

Type of network (Ethernet, WiFi, etc.)

isOfType

boolean isOfType(ICommNetwork.NetworkType type)

Checks if this network is compatible with given type.

Parameters:

type -

Returns:

true if this network supports the given type

getDeviceScanner

IDeviceScanner getDeviceScanner()

Returns:

Device scanner for this network or null if device discovery is not supported

getAvailableNetworks

java.util.Collection<? extends INetworkInfo> getAvailableNetworks()

Returns:

the list of networks available with this module -> move to INetworkManager