com.esf.device.usb.manager.ethernet.service
Interface IUsb2EthernetManagerService


public interface IUsb2EthernetManagerService


Field Summary
static java.lang.String SERVICE_NAME
          Reports the class name representing this interface.
static java.lang.String USB2ETHERNET_ATTACHED_TOPIC
           
static java.lang.String USB2ETHERNET_DETACHED_TOPIC
           
static java.lang.String USB2ETHERNET_PROPERTY_USB_ETHERNET_INTERFACE_NAME
           
static java.lang.String USB2ETHERNET_PROPERTY_USB_PORT_ADDRESS
           
 
Method Summary
 boolean areDevicesPresent()
          This method returns whether or not there are any devices currently attached.
 java.lang.String[] getDeviceUsbPorts()
          Returns an array of Strings that represent the USB port names of the connected devices
 java.lang.String getInterfaceName(java.lang.String usbPortNumber)
          This method returns the Ethernet interface names that have been assigned to the USB-to-Ethernet device attached to a specified USB port.
 void registerListener(Usb2EthernetListener listener)
          This method registers an USB-To-Ethernet Listener to be notified when a device has been attached or detached
 void unregisterListener(Usb2EthernetListener listener)
          This method unregisters an USB-To-Ethernet Listener
 

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME
Reports the class name representing this interface.


USB2ETHERNET_ATTACHED_TOPIC

static final java.lang.String USB2ETHERNET_ATTACHED_TOPIC
See Also:
Constant Field Values

USB2ETHERNET_DETACHED_TOPIC

static final java.lang.String USB2ETHERNET_DETACHED_TOPIC
See Also:
Constant Field Values

USB2ETHERNET_PROPERTY_USB_PORT_ADDRESS

static final java.lang.String USB2ETHERNET_PROPERTY_USB_PORT_ADDRESS
See Also:
Constant Field Values

USB2ETHERNET_PROPERTY_USB_ETHERNET_INTERFACE_NAME

static final java.lang.String USB2ETHERNET_PROPERTY_USB_ETHERNET_INTERFACE_NAME
See Also:
Constant Field Values
Method Detail

areDevicesPresent

boolean areDevicesPresent()
This method returns whether or not there are any devices currently attached.

Returns:
True if there are any devices attached, false otherwise.

getDeviceUsbPorts

java.lang.String[] getDeviceUsbPorts()
Returns an array of Strings that represent the USB port names of the connected devices

Returns:
An array of Strings that represent the USB port names of the connected devices

getInterfaceName

java.lang.String getInterfaceName(java.lang.String usbPortNumber)
This method returns the Ethernet interface names that have been assigned to the USB-to-Ethernet device attached to a specified USB port.

Parameters:
usbPortNumber - A String representing the USB port that the device is plugged into.
Returns:
A String representing the Ethernet interface name that has been assigned to the device. Null if no device is connected to the specified USB port.

registerListener

void registerListener(Usb2EthernetListener listener)
This method registers an USB-To-Ethernet Listener to be notified when a device has been attached or detached

Parameters:
listener - A class implementing the Usb2EthernetListener interface

unregisterListener

void unregisterListener(Usb2EthernetListener listener)
This method unregisters an USB-To-Ethernet Listener

Parameters:
listener - A class implementing the Usb2EthernetListener interface