com.cognex.dataman.sdk.discovery

Class EthernetDiscoverer

java.lang.Object

com.cognex.dataman.sdk.discovery.EthernetDiscoverer

public class EthernetDiscoverer
extends java.lang.Object

Discovers available DataMan devices on the specified network interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EthernetDiscoverer.OnDataManDeviceDetectedListener Interface definition for a callback to be invoked if a device is found.

Constructor Summary

Constructors

Constructor and Description
EthernetDiscoverer(java.net.NetworkInterface ni, Handler handler, EthernetDiscoverer.OnDataManDeviceDetectedListener listener) Creates an EthernetDiscoverer object on the specified NetworkInterface

Method Summary

Modifier and Type	Method and Description
int	getDeviceFilter()
void	sendIdentifier() Send identifier packet on the network.
void	setDeviceFilter(int deviceFilter)
void	setLogger(Logger logger) Sets the optional logger which can be used for debugging purposes.
void	startDeviceDiscovery() Starts the device discovery process.
void	startDeviceDiscovery(boolean treatBootupAsHello) Starts the device discovery process.
void	stopDeviceDiscovery() Cancels the currently running device discovery.
static EthernetDiscoverer	wifiInterfaceDiscoverer(Context context, EthernetDiscoverer.OnDataManDeviceDetectedListener listener) Discovers available DataMan devices on the WiFi network, if available, and executes the listener on the main looper Handler.
static EthernetDiscoverer	wifiInterfaceDiscoverer(Context context, Handler handler, EthernetDiscoverer.OnDataManDeviceDetectedListener listener) Discovers available DataMan devices on the WiFi network, if available.

Methods inherited from class java.lang.Object

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

Constructor Detail

EthernetDiscoverer

public EthernetDiscoverer(java.net.NetworkInterface ni,
                          Handler handler,
                          EthernetDiscoverer.OnDataManDeviceDetectedListener listener)
                   throws java.lang.IllegalArgumentException

Creates an EthernetDiscoverer object on the specified NetworkInterface

Parameters:

ni - The NetworkInterface object to use for discovering the devices

handler - The Handler object to be used to execute the listeners on its thread. (specify null for main looper Handler)

listener - The EthernetDiscoverer.OnDataManDeviceDetectedListener listener to invoke if a device is found.

Throws:

java.lang.IllegalArgumentException - if no InterfaceAddress is available on the specified NetworkInterface

Method Detail

wifiInterfaceDiscoverer

public static EthernetDiscoverer wifiInterfaceDiscoverer(Context context,
                                                         Handler handler,
                                                         EthernetDiscoverer.OnDataManDeviceDetectedListener listener)

Discovers available DataMan devices on the WiFi network, if available. Please specify android.permission.ACCESS_WIFI_STATE permission in manifest to use this method.

Parameters:

context - The Context object to use.

handler - The Handler object to be used to execute the listeners on its thread. (specify null for main looper Handler)

listener - The EthernetDiscoverer.OnDataManDeviceDetectedListener listener to invoke if a device is found.

Returns:

an EthernetDiscoverer instance configured for the device Wifi connection, or null if the Wifi is not available.

wifiInterfaceDiscoverer

public static EthernetDiscoverer wifiInterfaceDiscoverer(Context context,
                                                         EthernetDiscoverer.OnDataManDeviceDetectedListener listener)

Discovers available DataMan devices on the WiFi network, if available, and executes the listener on the main looper Handler.

Parameters:

context - The Context object to use.

listener - The EthernetDiscoverer.OnDataManDeviceDetectedListener listener to invoke if a device is found.

Returns:

an EthernetDiscoverer instance configured for the device Wifi connection, or null if the Wifi is not available.

getDeviceFilter

public int getDeviceFilter()

setDeviceFilter

public void setDeviceFilter(int deviceFilter)

startDeviceDiscovery

public void startDeviceDiscovery()
                          throws java.lang.IllegalArgumentException,
                                 java.lang.IllegalStateException

Starts the device discovery process.

Throws:

java.lang.IllegalArgumentException - if the interface can not be opened.

java.lang.IllegalStateException

startDeviceDiscovery

public void startDeviceDiscovery(boolean treatBootupAsHello)
                          throws java.lang.IllegalArgumentException,
                                 java.lang.IllegalStateException

Starts the device discovery process.

Parameters:

treatBootupAsHello - If true, the listener will treat Bootup packets as Hello packets when processing incoming cognamer packets.

Throws:

java.lang.IllegalArgumentException - if the interface can not be opened.

java.lang.IllegalStateException

sendIdentifier

public void sendIdentifier()
                    throws java.lang.IllegalArgumentException

Send identifier packet on the network. Useful to reuse existing instance.

Throws:

java.lang.IllegalArgumentException

stopDeviceDiscovery

public void stopDeviceDiscovery()

Cancels the currently running device discovery.

setLogger

public void setLogger(Logger logger)

Sets the optional logger which can be used for debugging purposes.

Parameters:

logger - The logger object to be used for logging.