|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The eWirelessAPIListener interface is defined here. This interface provides api users with a way of receiving asynchronous api events. API users should implement this interface and call the method addWirelessAPIListener() to register the implementation
Method Summary | |
void |
eMsg_AdapterInitialized(eInterfaceHandle theInterfaceHandle,
java.lang.String theInterfaceName)
This event contains the results of a call to the eOpenInterface function and indicates that the modem or network device has been successfully initialized. |
void |
eMsg_AdapterResetInProgress(eInterfaceHandle theInterfaceHandle)
This event Indicates that the network adapter has encountered an error and is attempting to reset itself. |
void |
eMsg_BatteryMode(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
int theBatteryMode)
This event contains the results of a call to the eSetBatteryMode or the eGetBatteryMode methods. |
void |
eMsg_BatteryStrength(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
int theNormalizedStrength,
int theRawStrength)
This event contains the results of a call to the GetBatteryStrength method. |
void |
eMsg_ChangePassword(int theReturnCode)
This event contains the results of a call to the eChangePassword method. |
void |
eMsg_CloseInterface(eInterfaceHandle theInterfaceHandle,
int theReturnCode)
This event contains the results of a call to the eCloseInterface method. |
void |
eMsg_ConnectionInfo(int theReturnCode,
eConnectionInfo theConnectionInfo)
This event contains the results of a call to the eGetConnectionInfo method. |
void |
eMsg_DisableTransmitter(eInterfaceHandle theInterfaceHandle,
int theReturnCode)
This event contains the results of a call to the eDisableTransmitter method. |
void |
eMsg_EnableTransmitter(eInterfaceHandle theInterfaceHandle,
int theReturnCode)
This event contains the results of a call to the eEnableTransmitter method. |
void |
eMsg_HardwareEvent(eInterfaceHandle theInterfaceHandle,
int theEventID)
This event is used only by the DataTAC/PMR network driver. |
void |
eMsg_Logoff(int theReturnCode)
This event contains the results of a call to the eLogoff method. |
void |
eMsg_Logon(int theReturnCode,
java.lang.String theConnectionConfigName)
This event contains the results of a call to the eLogon method. |
void |
eMsg_NetworkAdapters(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
eNetworkAdapters theAdapters)
|
void |
eMsg_NetworkCapabilities(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
eNetworkCapabilities theNetworkCapabilities)
This event contains the results of a call to the eGetNetworkCapabilities method. |
void |
eMsg_NetworkCongested(eInterfaceHandle theInterfaceHandle)
This event indicates that the modem has reported that the network is congested or that the modem buffers are full. |
void |
eMsg_NetworkInRange(eInterfaceHandle theInterfaceHandle)
This event indicates that the modem is now in range of the network. |
void |
eMsg_NetworkMessage(eInterfaceHandle theInterfaceHandle,
java.lang.String theNetworkMessage)
This event is used only for DataTAC/PMR networks. |
void |
eMsg_NetworkNoLongerCongested(eInterfaceHandle theInterfaceHandle)
This event indicates that the modem has reported that the network is no longer congested. |
void |
eMsg_NetworkOutOfRange(eInterfaceHandle theInterfaceHandle)
This event indicates that the modem is now out of range of the network and cannot send or receive data. |
void |
eMsg_NetworkSpecific(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
int theNetworkCapabilities,
java.lang.String theNetworkSpecificMessage)
This event contains the results of a call to the eGetNetworkSpecific method. |
void |
eMsg_NetworkStatus(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
eNetworkStatus theNetworkStatus)
This event contains the results of a call to the eGetNetworkStatus method. |
void |
eMsg_NotifyTray(eInterfaceHandle theInterfaceHandle,
int theReturnCode)
|
void |
eMsg_OpenInterface(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
int theNetworkSpecificRC,
java.lang.String theInterfaceName)
This event contains the results of a call to the eOpenInterface method. |
void |
eMsg_PacketReceived(eInterfaceHandle theInterfaceHandle,
int thePacketSize)
This event indicates that the Wireless Client has received a packet. |
void |
eMsg_PacketReceiveFailed(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
int packetSize)
This event indicates that the Wireless Client encountered a error receiving a packet. |
void |
eMsg_PacketTransmitFailed(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
int packetSize)
This event indicates that the Wireless Client encountered an error transmitting a packet. |
void |
eMsg_PacketTransmitted(eInterfaceHandle theInterfaceHandle,
int thePacketSize)
This event indicates that the Wireless Client has sent a packet to the network. |
void |
eMsg_RadiusAuthentication(eInterfaceHandle theInterfaceHandle,
int theReturnCode)
This event contains the results of a call to the eAuthenticate method. |
void |
eMsg_RedialAttempt(eInterfaceHandle theInterfaceHandle,
int theReturnCode)
This event indicates that the Wireless Client is redialing the network, possibley as the result of a call to the eSendRedialMessage method. |
void |
eMsg_ResumeInterface(eInterfaceHandle theInterfaceHandle,
int theReturnCode)
This event contains the results of a call to the eResumeInterface method./p> |
void |
eMsg_RFModemStatistics(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
eRFModemStatistics theRFModemStatistics)
This event contains the results of a call to the eGetRFModemStatistics method. |
void |
eMsg_RFModemStatus(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
eRFModemStatus theRFModemStatus)
This event contains the results of a call to the eGetRFModemStatus method. |
void |
eMsg_SetActiveInterface(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
eInterfaceHandle theNewActiveInterface,
eInterfaceHandle theOldActiveInterface)
This event contains a return code indicating success or failure for the eSetActiveInterface attempt, the interface handle that was active prior to the call, and the new active interface handle (if the operation was successful). |
void |
eMsg_Shutdown()
This event indicates that the Wireless Client executable is no longer running. |
void |
eMsg_SignalQuality(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
int theNormalizedQuality,
int theRawQuality)
This event contains the results of a call to the GetSignalQuality method. |
void |
eMsg_SignalStrength(eInterfaceHandle theInterfaceHandle,
int theReturnCode,
int theNormalizedStrength,
int theRawStrength)
This event contains the results of a call to the GetSignalStrength method. |
void |
eMsg_SuspendInterface(eInterfaceHandle theInterfaceHandle,
int theReturnCode)
This event contains the results of a call to the eSuspendInterface method. |
Method Detail |
public void eMsg_AdapterInitialized(eInterfaceHandle theInterfaceHandle, java.lang.String theInterfaceName)
This event contains the results of a call to the eOpenInterface function and indicates that the modem or network device has been successfully initialized. This event marks an intermediate step in the connection process. The next step in the connection process is to attempt to communicate with the network.
Because not all networks support this event, applications can ignore it and wait for the concluding eMsg_OpenInterface event. This event is not posted if the modem cannot be initialized; instead, the eMsg_OpenInterface event is posted with a return code of eErrModemInitFailed
theInterfaceHandle
- Interface to which this event relatestheInterfaceName
- Contains the string interfaceName passed in on the associated eOpenInterface call.eWirelessAPI.eOpenInterface(String, String, eInterfaceHandle)
public void eMsg_AdapterResetInProgress(eInterfaceHandle theInterfaceHandle)
This event Indicates that the network adapter has encountered an error and is attempting to reset itself. This event should be followed by an eOpenInterface event indicating the success or failure of the attempt.
theInterfaceHandle
- Interface to which this event relatespublic void eMsg_BatteryMode(eInterfaceHandle theInterfaceHandle, int theReturnCode, int theBatteryMode)
This event contains the results of a call to the eSetBatteryMode or the eGetBatteryMode methods.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- theBatteryMode
- eWirelessAPI.eGetBatteryMode(eInterfaceHandle)
,
eWirelessAPI.eSetBatteryMode(eInterfaceHandle, int)
public void eMsg_BatteryStrength(eInterfaceHandle theInterfaceHandle, int theReturnCode, int theNormalizedStrength, int theRawStrength)
This event contains the results of a call to the GetBatteryStrength method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- theNormalizedStrength
- Contains the normalized battery strength value (on a 0-100 scale).theRawStrength
- Contains the actual battery strength value returned by the modem.eWirelessAPI.eGetBatteryStrength(eInterfaceHandle)
public void eMsg_ChangePassword(int theReturnCode)
This event contains the results of a call to the eChangePassword method.
theReturnCode
- eWirelessAPI.eChangePassword(String, String)
public void eMsg_CloseInterface(eInterfaceHandle theInterfaceHandle, int theReturnCode)
This event contains the results of a call to the eCloseInterface method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- eWirelessAPI.eCloseInterface(eInterfaceHandle)
public void eMsg_ConnectionInfo(int theReturnCode, eConnectionInfo theConnectionInfo)
This event contains the results of a call to the eGetConnectionInfo method.
theReturnCode
- theConnectionInfo
- An eConnectionInfo
object containing the connection info
returned as a result of the call to eGetConnectionInfoeWirelessAPI.eGetConnectionInfo()
,
eConnectionInfo
public void eMsg_DisableTransmitter(eInterfaceHandle theInterfaceHandle, int theReturnCode)
This event contains the results of a call to the eDisableTransmitter method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- eWirelessAPI.eDisableTransmitter(eInterfaceHandle)
public void eMsg_EnableTransmitter(eInterfaceHandle theInterfaceHandle, int theReturnCode)
This event contains the results of a call to the eEnableTransmitter method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- eWirelessAPI.eEnableTransmitter(eInterfaceHandle)
public void eMsg_HardwareEvent(eInterfaceHandle theInterfaceHandle, int theEventID)
This event is used only by the DataTAC/PMR network driver. The modem has issued a hardware event.
theInterfaceHandle
- Interface to which this event relatestheEventID
- public void eMsg_Logoff(int theReturnCode)
This event contains the results of a call to the eLogoff method.
theReturnCode
- eWirelessAPI.eLogoff()
public void eMsg_Logon(int theReturnCode, java.lang.String theConnectionConfigName)
This event contains the results of a call to the eLogon method.
theReturnCode
- eWirelessAPI.eLogon(String, String, String, String)
public void eMsg_NetworkCapabilities(eInterfaceHandle theInterfaceHandle, int theReturnCode, eNetworkCapabilities theNetworkCapabilities)
This event contains the results of a call to the eGetNetworkCapabilities method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- theNetworkCapabilities
- An eNetworkCapabilities
object containing the network capabilitieseWirelessAPI.eGetNetworkCapabilities(eInterfaceHandle)
,
eNetworkCapabilities
public void eMsg_NetworkCongested(eInterfaceHandle theInterfaceHandle)
This event indicates that the modem has reported that the network is congested or that the modem buffers are full. Outgoing packets may be lost.
theInterfaceHandle
- Interface to which this event relatespublic void eMsg_NetworkInRange(eInterfaceHandle theInterfaceHandle)
This event indicates that the modem is now in range of the network.
theInterfaceHandle
- Interface to which this event relatespublic void eMsg_NetworkMessage(eInterfaceHandle theInterfaceHandle, java.lang.String theNetworkMessage)
This event is used only for DataTAC/PMR networks. The network has delivered an unsolicited text message.
theInterfaceHandle
- Interface to which this event relatestheNetworkMessage
- The text message received from the network.public void eMsg_NetworkNoLongerCongested(eInterfaceHandle theInterfaceHandle)
This event indicates that the modem has reported that the network is no longer congested. This event will be preceeded by an eMsg_NetworkCongested event.
theInterfaceHandle
- Interface to which this event relatespublic void eMsg_NetworkOutOfRange(eInterfaceHandle theInterfaceHandle)
This event indicates that the modem is now out of range of the network and cannot send or receive data.
theInterfaceHandle
- Interface to which this event relatespublic void eMsg_NetworkSpecific(eInterfaceHandle theInterfaceHandle, int theReturnCode, int theNetworkCapabilities, java.lang.String theNetworkSpecificMessage)
This event contains the results of a call to the eGetNetworkSpecific method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- theNetworkCapabilities
- This field contains a bit mask representing the operations this modem supports. The bit masks used are described in ART_CAPABILITY bit masks.theNetworkSpecificMessage
- String with the network-specific information in a displayable format. The string contents vary by network type.eWirelessAPI.eGetNetworkSpecific(eInterfaceHandle)
public void eMsg_NetworkStatus(eInterfaceHandle theInterfaceHandle, int theReturnCode, eNetworkStatus theNetworkStatus)
This event contains the results of a call to the eGetNetworkStatus method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- theNetworkStatus
- An eNetworkStatus
object containing the network statuseWirelessAPI.eGetNetworkStatus(eInterfaceHandle)
,
eNetworkStatus
public void eMsg_NotifyTray(eInterfaceHandle theInterfaceHandle, int theReturnCode)
public void eMsg_OpenInterface(eInterfaceHandle theInterfaceHandle, int theReturnCode, int theNetworkSpecificRC, java.lang.String theInterfaceName)
This event contains the results of a call to the eOpenInterface method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- theNetworkSpecificRC
- If theReturnCode is not equal to eOK, this field may contain a network-specific return code. Check the network driver documentation for details on interpreting this fieldtheInterfaceName
- Contains the string interfaceName passed in on the associated eOpenInterface call.eWirelessAPI.eOpenInterface(String, String,eInterfaceHandle)
public void eMsg_PacketReceived(eInterfaceHandle theInterfaceHandle, int thePacketSize)
This event indicates that the Wireless Client has received a packet.
theInterfaceHandle
- Interface to which this event relatesthePacketSize
- Size (in bytes) of the packet that was received.public void eMsg_PacketReceiveFailed(eInterfaceHandle theInterfaceHandle, int theReturnCode, int packetSize)
This event indicates that the Wireless Client encountered a error receiving a packet. The packet could have been corrupted, incomplete, or discarded by the network.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- thePacketSize
- Size (in bytes) of the packetpublic void eMsg_PacketTransmitFailed(eInterfaceHandle theInterfaceHandle, int theReturnCode, int packetSize)
This event indicates that the Wireless Client encountered an error transmitting a packet. /p>
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- thePacketSize
- Size (in bytes) of the packetpublic void eMsg_PacketTransmitted(eInterfaceHandle theInterfaceHandle, int thePacketSize)
This event indicates that the Wireless Client has sent a packet to the network. /p>
theInterfaceHandle
- Interface to which this event relatesthePacketSize
- Size (in bytes) of the packetpublic void eMsg_RadiusAuthentication(eInterfaceHandle theInterfaceHandle, int theReturnCode)
This event contains the results of a call to the eAuthenticate method. /p>
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- eWirelessAPI.eAuthenticate(String, String)
public void eMsg_RedialAttempt(eInterfaceHandle theInterfaceHandle, int theReturnCode)
This event indicates that the Wireless Client is redialing the network, possibley as the result of a call to the eSendRedialMessage method. /p>
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- eWirelessAPI.eSendRedialMessage(eInterfaceHandle)
public void eMsg_ResumeInterface(eInterfaceHandle theInterfaceHandle, int theReturnCode)
This event contains the results of a call to the eResumeInterface method./p>
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- eWirelessAPI.eResumeInterface(eInterfaceHandle)
public void eMsg_SetActiveInterface(eInterfaceHandle theInterfaceHandle, int theReturnCode, eInterfaceHandle theNewActiveInterface, eInterfaceHandle theOldActiveInterface)
This event contains a return code indicating success or failure for the eSetActiveInterface attempt, the interface handle that was active prior to the call, and the new active interface handle (if the operation was successful). If the operation fails, the state of the current active interface is left unchanged./p>
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- theNewActiveInterface
is now the active interface. theOldActiveInterface
remains the active interface. theOldActiveInterface
remains the active interface.theNewActiveInterface
- Contains the new active interface handle specified in the eSetActiveInterface call.theOldActiveInterface
- Contains the name of the interface interface that was active prior to the call to eSetActiveInterfaceeWirelessAPI.eSetActiveInterface(eInterfaceHandle)
public void eMsg_Shutdown()
This event indicates that the Wireless Client executable is no longer running. If you receive this event, you no longer have a valid handle to the API. To continue using the API, you will need to call eCloseAPI and the eOpenAPI method again to reinitialize the API and restart the Wireless Client./p>
eWirelessAPI.eShutdown()
,
eWirelessAPI.eOpenApi()
,
eWirelessAPI.eCloseApi()
public void eMsg_SignalQuality(eInterfaceHandle theInterfaceHandle, int theReturnCode, int theNormalizedQuality, int theRawQuality)
This event contains the results of a call to the GetSignalQuality method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- theNormalizedQuality
- Contains the normalized signal quality value (on a 0-100 scale).theRawQuality
- Contains the actual signal quality value returned by the modem.eWirelessAPI.eGetSignalQuality(eInterfaceHandle)
public void eMsg_SignalStrength(eInterfaceHandle theInterfaceHandle, int theReturnCode, int theNormalizedStrength, int theRawStrength)
This event contains the results of a call to the GetSignalStrength method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- theNormalizedStrength
- Contains the normalized signal strength value (on a 0-100 scale).theRawStrength
- Contains the actual signal strength value returned by the modem.eWirelessAPI.eGetSignalStrength(eInterfaceHandle)
public void eMsg_SuspendInterface(eInterfaceHandle theInterfaceHandle, int theReturnCode)
This event contains the results of a call to the eSuspendInterface method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- eWirelessAPI.eSuspendInterface(eInterfaceHandle)
public void eMsg_RFModemStatus(eInterfaceHandle theInterfaceHandle, int theReturnCode, eRFModemStatus theRFModemStatus)
This event contains the results of a call to the eGetRFModemStatus method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- theRFModemStatus
- An eRFModemStatus
object containing the RF modem status
returned as a result of the call to eGetRFModemStatuseWirelessAPI.eGetRFModemStatus(eInterfaceHandle)
,
eRFModemStatus
public void eMsg_RFModemStatistics(eInterfaceHandle theInterfaceHandle, int theReturnCode, eRFModemStatistics theRFModemStatistics)
This event contains the results of a call to the eGetRFModemStatistics method.
theInterfaceHandle
- Interface to which this event relatestheReturnCode
- theRFModemStatus
- An eRFModemStatistics
object containing the RF modem statistics
returned as a result of the call to eGetRFModemStatisticseWirelessAPI.eGetRFModemStatistics(eInterfaceHandle)
,
eRFModemStatistics
public void eMsg_NetworkAdapters(eInterfaceHandle theInterfaceHandle, int theReturnCode, eNetworkAdapters theAdapters)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |