Since: API Level 4.20

public class

Wimax4GManager

extends FourGManager

java.lang.Object
↳	com.htc.net.FourG.FourGManager
	↳	com.htc.net.wimax.Wimax4GManager

Known Direct Subclasses

HTCWimax4GManager

Class Overview

This class provides the primary API for managing all aspects of Wimax connectivity. Get an instance of this class by calling Context.getSystemService(Context.WIMAX_SERVICE). It deals with several categories of items:

The list of configured networks. The list can be viewed and updated, and attributes of individual entries can be modified.
The currently active Wimax network, if any. Connectivity can be established or torn down, and dynamic information about the state of the network can be queried.
Results of access point scans, containing enough information to make decisions about what access point to connect to.
It defines the names of various Intent actions that are broadcast upon any sort of change in Wimax state.

This is the API to use when performing Wimax specific operations. To perform operations that pertain to network connectivity at an abstract level, use ConnectivityManager.

Summary

Nested Classes
class	Wimax4GManager.WimaxConnectionStatistics	This class provides access to certain WiMAX radio technology-specific connection related information related to the current overall performance data communications between the Mobile Station and the serving Base Station.
class	Wimax4GManager.WimaxQosServiceFlowControl	This class provides access to and control of the potential QoS service flows between the Mobile Station and the serving Base Station.

[Expand]

Inherited Constants

From class com.htc.net.FourG.FourGManager

String	CINR_CHANGED_ACTION	The CINR (signal strength) has changed.
int	ERROR_ALREADY_CONNECTED	Error code indicating that seen from call to getLastError() indicating that the MS is already connected to a serving BS, in situations where the calling application has called reconnect() or connectDefaultNetwork() when a active connection already is established.
int	ERROR_AUTHENTICATING	Error code indicating that there was a problem authenticating.
int	ERROR_DEVICE_NOT_PROVISIONED	Error code typically seen from call to getLastError() indicating that the dev ice has not been provisioned and 4G operation is not possible
int	ERROR_DEVICE_PROVISIONING_DATA_ERROR	Error code typically seen from call to getLastError() indicating that the dev ice has been provisioned but there is a detectable error in the provisioning data and thus 4G operation is not possible
int	ERROR_INVALID_DEVICE_PROFILE	Error code typically seen from call to getLastError() broadly indicating that the dev ice profile is invalid and 4G operation is not possible
int	ERROR_NO_COVERAGE_AVAILABLE	Error code typically seen from call to getLastError() indicating that no coverage is available to the MS.
int	ERROR_OPERATION_ALREADY_IN_PROGRESS	Error code typically seen from call to getLastError() indicating that the MS is already in progress executing a previously initiated function
int	ERROR_OPERATION_NOT_ALLOWED	Error code typically seen from call to getLastError() indicating that the User Equirpment implementation does not allow the particular operation at this application interface.
int	ERROR_RADIO_OFF	Error code typically seen from call to getLastError() indicating that the MS 4G radio is off, having been disabled in a control panel and/or by a physical switch
int	ERROR_RADIO_POLICY_VIOLATION	Error code typically seen from call to getLastError() indicating that the MS has detected a radio policy violation.
int	ERROR_ROAMING_NOT_ALLOWED	Error code typically seen from call to getLastError() indicating that roaming is not supported at this time.
int	ERROR_SCAN_NOT_ALLOWED_NOW_NETWORK_IMPACTS	Error code indicating that a scan was not begin as there is a (typically) transient condition in the network that would be problematic for network operations if a MS initialed scan was executed at this time
int	ERROR_SCAN_NOT_ALLOWED_NOW_NETWORK_MGMT_PROHIBITED	Error code indicating that the requested scan was not initiated as there is policy in place where the network, possibly via OMA-DM, prohibits the specific scan operation at this time.
int	ERROR_SCAN_NOT_ALLOWED_NOW_UE_DATA_XFER_IMPACTS	Error code indicating that a scan was not begun as the scan would disrupt on-going data transports.
String	EXTRA_4G_CURRENT_SERVING_BS	The lookup key for a `FourGBaseStationInfo` describing the now serving BS Station.
String	EXTRA_4G_INFO	The lookup key for the RAN-specific subclass of FourGInfo, describing the current User Equipment <-> base station connection, when a Intent is received.
String	EXTRA_4G_PREVIOUS_SERVING_BS	The lookup key for a FourGBaseStationInof describing the previous serving BS Station.
String	EXTRA_4G_STATE	The lookup key for an `int` that indicates the current 4G "enabled" state, describing if 4G is enabled, disabled, enabling, disabling, or unknown Retrieve it with `getIntExtra(String, int)`.
String	EXTRA_CURRENT_RADIO_TEMPERATURE	The lookup key for the current radio temperature in Celsius.
String	EXTRA_DOWNLINK_MODULATION	The lookup key for a Four4BaseStateionInfo.eNET_4G_MODULATION
String	EXTRA_DOWNLINK_THROUGHPUT	The lookup key for an int representing downlink throughput in LINK_SPEED_UNITS
String	EXTRA_HANDOVER_FAILURE_REASON	The lookup key for a enum FourGInfo.LINK_STATE_REASON that indicates the reason why a BAse Station to Base Station handover failed.
String	EXTRA_LINK_STATE_DETAIL	The lookup key for a FourGInfo.LINK_STATE_DETAIL
String	EXTRA_NETWORK_INFO	The lookup key for a `NetworkInfo` object associated with the 4G network.
String	EXTRA_NEW_4G_STATE	The lookup key for a `FourGSupplicantState` describing the new state Retrieve with `getParcelableExtra(String)`.
String	EXTRA_NEW_CINR	The lookup key for an `int` giving the new CINR in dB.
String	EXTRA_NEW_RSSI	The lookup key for an `int` giving the new RSSI in dBm.
String	EXTRA_PREVIOUS_4G_STATE	The lookup key for an `int` that indicates the previous 4G "enabled" state, describing if 4G is enabled, disabled, enabling, disabling, or unknown.
String	EXTRA_SCAN_RESULT_BS_LIST	The lookup key for the list of base station found after a scan has completed.
String	EXTRA_SERVICE_FLOW	The lookup key for the QosServiceFlowDescriptor
String	EXTRA_SF_SCHEDULING_CLASS	The lookup key for the new SF_SCHEDULING_CLASS
String	EXTRA_SF_STATE	The lookup key for the new SF_STATE
String	EXTRA_SUPPLICANT_ERROR	The lookup key for a `FourGSupplicantState` describing the supplicant error code if any.
String	EXTRA_UPLINK_MODULATION	The lookup key for a Four4BaseStateionInfo.eNET_4G_MODULATION
String	EXTRA_UPLINK_THROUGHPUT	The lookup key for an int representing uplink throughput in LINK_SPEED_UNITS
String	KEY_CINR_CHANGED	Key used for the Bundle extra holding a boolean indicating that the Intent is a CINR changed alert.
String	KEY_CINR_DELTA_THRESHOLD	Key used for the single Bundle extra, in an "CINR changed" alert Intent, to access a boolean which, if true, indicates that the Intent was fired based on the occurrence of an CINR change that exceeded the previous specified "CINR changed" by more that the minDelta threshold valuee.
String	KEY_CINR_MAX_THRESHOLD	Key used for the single Bundle extra, in an "CINR changed" alert Intent, to access an int which, if not equal to Integer.MAX_VALUE, indicates that the Intent was fired based on the occurrence of an CINR change, where, at some time during the alert minDelta peroid, the new CINR value was below the previously specifed "CINR maximum absolute" threshold value ceilingValue.
String	KEY_CINR_MIN_THRESHOLD	Key used for the single Bundle extra, in an "CINR changed" alert Intent, to access an int which, if not equal to Integer.MIN_VALUE, indicates that the Intent was fired based on the occurrence of an CINR change, where, at some time during the alert minDelta peroid, the new CINR value was below the previously specifed "CINR minimum absolute" threshold value floorValue.
String	KEY_CINR_PERIODIC_ALERT	Key used for the single Bundle extra, in an "CINR changed" alert Intent, to access a boolean which, if true, indicates that the Intent was fired based on the occurrence of an CINR change, and the previously specified minimum reporting time period has passed.
String	KEY_NEW_CINR	Key used for the single Bundle extra, in an "CINR changed" alert Intent, to access an int which is the new CINR value.
String	KEY_NEW_RSSI	Key used for the single Bundle extra, in an "RSSI changed" alert Intent, to access an int which is the new RSSI value.
String	KEY_RSSI_CHANGED	Key used for the Bundle extra holding a boolean indicating that the Intent is a RSSI changed alert.
String	KEY_RSSI_DELTA_THRESHOLD	Key used for the single Bundle extra, in an "RSSI changed" alert Intent, to access a boolean which, if true, indicates that the Intent was fired based on the occurrence of an RSSI change that exceeded the previous specified "RSSI changed" by more that the minDelta threshold valuee.
String	KEY_RSSI_MAX_THRESHOLD	Key used for the single Bundle extra, in an "RSSI changed" alert Intent, to access an int which, if not equal to Integer.MAX_VALUE, indicates that the Intent was fired based on the occurrence of an RSSI change, where, at some time during the alert minDelta peroid, the new RSSI value was below the previously specifed "RSSI maximum absolute" threshold value ceilingValue.
String	KEY_RSSI_MIN_THRESHOLD	Key used for the single Bundle extra, in an "RSSI changed" alert Intent, to access an int which, if not equal to Integer.MIN_VALUE, indicates that the Intent was fired based on the occurrence of an RSSI change, where, at some time during the alert minDelta peroid, the new RSSI value was below the previously specifed "RSSI minimum absolute" threshold value floorValue.
String	KEY_RSSI_PERIODIC_ALERT	Key used for the single Bundle extra, in an "RSSI changed" alert Intent, to access a boolean which, if true, indicates that the Intent was fired based on the occurrence of an RSSI change, and the previously specified minimum reporting time period has passed.
String	LINK_MODULATION_CHANGED_ACTION	Broadcast intent action indicating that the modulation on the 4G radio link state has changed.
String	LINK_STATE_DETAIL_CHANGED_ACTION	Broadcast intent action indicating that the state of 4G detailed link state has changed.
int	LOG_DEBUG
int	LOG_ERROR
int	LOG_FATAL	log Levels
int	LOG_WARNING
String	NETWORK_IDS_CHANGED_ACTION	The network IDs of the configured networks could have changed.
String	NETWORK_STATE_CHANGED_ACTION	Broadcast intent action indicating that the state of 4G connectivity has changed.
String	NET_4G_HANDOVER_COMPLETE_ACTION	Broadcast intent action indicating that the 4G serving Base Station (BS) has changed.
String	NET_4G_HANDOVER_FAILED_ACTION	Broadcast intent action indicating that the handover between 4G serving Base Station has failed.
String	NET_4G_RADIO_OVERHEAT_ACTION	Broadcast intent action indicating that the 4G radio has overheated.
String	NET_4G_STATE_CHANGED_ACTION	Broadcast intent action indicating that the 4G "enabled" state (enabled, disabled, enabling, disabling, or unknown) has changed.
int	NET_4G_STATE_DISABLED	4G is disabled
int	NET_4G_STATE_DISABLING	4G is being disabled
int	NET_4G_STATE_ENABLED	4G is enabled
int	NET_4G_STATE_ENABLING	4G is being enabled
int	NET_4G_STATE_UNKNOWN	4G is in an unknown state
String	QOS_SERVICE_FLOW_MODIFIED_ACTION	Broadcast intent action indicating that the state of 4G service flow has been modified by a change in serving BS, by the serving BS, etc.
String	QOS_SERVICE_FLOW_STATE_CHANGE_ACTION	Broadcast intent action indicating that the state of a 4G service flow has made a state transition.
String	RSSI_CHANGED_ACTION	The RSSI (signal strength) has changed.
String	SCAN_RESULTS_AVAILABLE_ACTION	A scan has completed, and result are available.
String	SUPPLICANT_STATE_CHANGED_ACTION	Broadcast intent action indicating that the state of establishing a connection to a Base Station has changed.
int	maxCINR
int	maxRSSI
int	minCINR
int	minRSSI	defined for singal calculation

Fields
protected final Handler	mHandler
protected final IWimaxController	mService

[Expand]

Inherited Fields

From class com.htc.net.FourG.FourGManager

Public Constructors
	Wimax4GManager(IWimaxController service, Handler handler)

Public Methods
int	addNetwork(FourGConfiguration config) Add a network description to the set of configured networks.
FourGManager.ConnectionStatistics	createConnectionStatistics() Get the upload/download statistics object for the current connection session.
FourGManager.QosServiceFlowControl	createQosServiceFlowControl() Create a new QoS control object for the 4G radio subsystem.
boolean	disableNetwork(int netId) The specified network will not be candidate for MS association/connection.
boolean	disconnect() Disassociate from the connected network and go to disconnected state.
void	enableLogLevel(int logLevel) enable wimax log level
boolean	enableNetwork(int netId, boolean disableOthers) Allow a previously configured network to be associated with.
List<FourGConfiguration>	getAvailableNetworks() Return the available networks to connect.
List<FourGConfiguration>	getConfiguredDefaultNetworks() Return a list of only those networks configured in the supplicant via means outside of this API, e.g.
List<FourGConfiguration>	getConfiguredNetworks() Return a list of al the networks configured in the supplicant.
FourGInfo	getConnectionInfo() Get the information about the currently connected network and base station, if any.
DeviceInfo	getDeviceInformation() Get the information about the 4G radio device on the system.
DhcpInfo	getDhcpInfo() Return the DHCP-assigned addresses from the last successful DHCP request, if any.
List<FourGBaseStationInfo>	getScanResults() Return the list of base stations from either the latest API initiated network scan and as may have been gathered as the result of other implementation-interanl, network management operations.
int	getScanResultsAge() Returns number of milliseconds since the base station scan list available from getScanResults() was last compiled.
boolean	reassociate() Reconnect to the currently active network, even if we are already connected.
boolean	reconnect() Reconnect to the currently active network, even if we are currently disconnected.
boolean	removeNetwork(int netId) Remove the specified network from the list of configured networks.
boolean	saveConfiguration() Tell the supplicant to persist the current list of configured networks, configured with this API.
boolean	set4GEnabled(boolean enabled) Turns the 4G radio on or off.
boolean	updateNetwork(FourGConfiguration config) Update the network description of an existing configured network.

[Expand]

Inherited Methods

From class com.htc.net.FourG.FourGManager

int	addNetwork(FourGConfiguration config) Add a network description to the set of configured networks.
static int	calculateSignalLevel(int rssi, int cinr, int numLevels) Calculates an ordinal number for signal level between 0 and numLevelsm mapping rssi in dBm, and/or cinr in dB, to a single dimensionless number.
static int	calculateSignalLevel(int rssi, int numLevels) Calculates an ordinal number for singal level between 0 and numLevels, mapping rssi, in dBm, to a single dimensionless number.
static int	compareSignalLevel(int rssiA, int rssiB) Compares two signal strengths.
int	connectDefaultNetwork() Connect to the current default ("home") network(s) using the default MS credentials.
static int	copmareCinrLevel(int cinrA, int cinrB) Compares two signal qualities.
FourGManager.ConnectionStatistics	createConnectionStatistics() Get the upload/download statistics object for the current connection session.
FourGManager.FourGLock	createFourGLock(String tag) Creates a new FourGManager.Lock.
abstract FourGManager.QosServiceFlowControl	createQosServiceFlowControl() Create a new QoS control object for the 4G radio subsystem.
boolean	disableNetwork(int netId) The specified network will not be candidate for MS association/connection.
boolean	disconnect() Disassociate from the connected network and go to disconnected state.
void	enableLogLevel(int logLevel) Enable logLevel in the Java/JNI and 'C' driver level.
boolean	enableNetwork(int netId, boolean disableOthers) Allow a previously configured network to be associated with.
int	get4GState() Returns the 4G enabled state, one of NET_4G_STATE_DISABLED, NET_4G_STATE_DISABLING, NET_4G_STATE_ENABLED, NET_4G_STATE_ENABLING, NET_4G_STATE_UNKNOWN
abstract List<FourGConfiguration>	getAvailableNetworks() Return the available networks to connect.
abstract List<FourGConfiguration>	getConfiguredDefaultNetworks() Return a list of only those networks configured in the supplicant via means outside of this API, e.g.
abstract List<FourGConfiguration>	getConfiguredNetworks() Return a list of al the networks configured in the supplicant.
abstract FourGInfo	getConnectionInfo() Get the information about the currently connected network and base station, if any.
DeviceInfo	getDeviceInformation() Get the information about the 4G radio device on the system.
DhcpInfo	getDhcpInfo() Return the DHCP-assigned addresses from the last successful DHCP request, if any.
FourGInfo.LINK_STATE_REASON	getDisconnectReason() Returns the last disconnect reason.
int	getLastError() Return the error code associated with the last operation.
FourGManager.RadioInfoTemperature	getRadioInfoTemperature() This method returns an object that encapsulates information aboud the radio attributes such as radio temp etc.
abstract List<FourGBaseStationInfo>	getScanResults() Return the list of base stations from either the latest API initiated network scan and as may have been gathered as the result of other implementation-interanl, network management operations.
int	getScanResultsAge() Returns number of milliseconds since the base station scan list available from getScanResults() was last compiled.
boolean	is4GEnabled() Return whether 4G is enabled or disabled.
boolean	isRoamingEnabled() Return whether network roaming is enabled or disable.
boolean	reassociate() Reconnect to the currently active network, even if we are already connected.
boolean	reconnect() Reconnect to the currently active network, even if we are currently disconnected.
void	removeCinrAlert(PendingIntent intent) Removes the CINR alert with the PendingIntent intent.
boolean	removeNetwork(int netId) Remove the specified network from the list of configured networks.
void	removeRssiAlert(PendingIntent intent) Removes the RSSI alert with the PendingIntent intent.
void	requestCinrAlerts(int minTime, int minDelta, int floorValue, int ceilingValue, PendingIntent intent) Registers the current activity to be notified periodically and/or when CINR has chagned enough to match the alert criteria as defined by the various parameters, with the spplied PendingIntent being broadcast with current CINR.
void	requestRssiAlerts(int minTime, int minDelta, int floorValue, int ceilingValue, PendingIntent intent) Registers the current activity to be notified periodically and/or when RSSI has chagned enough to match the alert criteria as defined by the various parameters, with the spplied PendingIntent being broadcast with current RSSI.
boolean	saveConfiguration() Tell the supplicant to persist the current list of configured networks, configured with this API.
boolean	set4GEnabled(boolean enabled) Turns the 4G radio on or off.
boolean	setRoamingEnabled(boolean enabled) Enables connection to roaming partner NSPs or disables such roaming.
int	startNeighborListScan(boolean wideScan, FourGManager.RtdRequestedSpec rtdSpec, boolean dataSessionInterruptionAllowed) Initiates various radio base station scanning modes.
boolean	updateNetwork(FourGConfiguration config) Update the network description of an existing configured network.

From class java.lang.Object

Fields

protected final Handler mHandler

Since: API Level 4.20

protected final IWimaxController mService

Since: API Level 4.20

Classes

Enums

Wimax4GManager

Class Overview

Summary

Fields

protected final Handler mHandler

protected final IWimaxController mService

Public Constructors

public Wimax4GManager (IWimaxController service, Handler handler)

Public Methods

public int addNetwork (FourGConfiguration config)

public FourGManager.ConnectionStatistics createConnectionStatistics ()

public FourGManager.QosServiceFlowControl createQosServiceFlowControl ()

public boolean disableNetwork (int netId)

public boolean disconnect ()

public void enableLogLevel (int logLevel)

public boolean enableNetwork (int netId, boolean disableOthers)

public List<FourGConfiguration> getAvailableNetworks ()

public List<FourGConfiguration> getConfiguredDefaultNetworks ()

public List<FourGConfiguration> getConfiguredNetworks ()

public FourGInfo getConnectionInfo ()

public DeviceInfo getDeviceInformation ()

public DhcpInfo getDhcpInfo ()

public List<FourGBaseStationInfo> getScanResults ()

public int getScanResultsAge ()

public boolean reassociate ()

public boolean reconnect ()

public boolean removeNetwork (int netId)

public boolean saveConfiguration ()

public boolean set4GEnabled (boolean enabled)

public boolean updateNetwork (FourGConfiguration config)