CYINetworkInformationBridge contains functions relating to device network state.
#include <network/YiNetworkInformationBridge.h>
◆ MobileNetworkType
Enumerator |
---|
NotApplicable | The mobile network speed does not apply to the current connection type.
|
Type2G | The mobile network speed is 2G.
|
Type3G | The mobile network speed is 3G.
|
Type4G | The mobile network speed is 4G.
|
Unknown | The mobile network speed is unknown.
|
◆ NetworkType
The type of network connection reported by the device.
Enumerator |
---|
NoConnection | There is no network connection.
|
Wifi | The current network connection is wifi.
|
Mobile | The current network connection is mobile, such as a 3G or 4G network.
|
Wired | The current network connection is wired, such as an ethernet connection.
|
Other | There is a network connection but the exact type cannot be determined.
|
Unknown | The network type is unknown.
|
◆ ~CYINetworkInformationBridge()
virtual CYINetworkInformationBridge::~CYINetworkInformationBridge |
( |
| ) |
|
|
inlinevirtual |
◆ GetConnectivity()
Returns an object that can be used to actively check network connectivity.
- Note
- The CYIHTTPService must be started for the connectivity class to function properly.
◆ GetMobileNetworkType()
virtual MobileNetworkType CYINetworkInformationBridge::GetMobileNetworkType |
( |
| ) |
const |
|
pure virtual |
◆ GetNetworkType()
virtual NetworkType CYINetworkInformationBridge::GetNetworkType |
( |
| ) |
|
|
pure virtual |
◆ HasCellularNetworkSupport()
virtual bool CYINetworkInformationBridge::HasCellularNetworkSupport |
( |
| ) |
|
|
pure virtual |
Returns true if the device supports a cellular network and false otherwise.
- Note
- Only indicates if the device has the capability to support cellular communications and not that it has a valid cellular network connection (meaning, a valid SIM card inserted)
◆ HasNetworkStateListenerStarted()
virtual bool CYINetworkInformationBridge::HasNetworkStateListenerStarted |
( |
| ) |
|
|
pure virtual |
Returns true if the network state listener has started and false otherwise.
◆ RefreshNetworkState()
virtual void CYINetworkInformationBridge::RefreshNetworkState |
( |
| ) |
|
|
pure virtual |
Refreshes the network state using the current network state.
◆ SetNetworkActivityIndicatorOff()
virtual void CYINetworkInformationBridge::SetNetworkActivityIndicatorOff |
( |
| ) |
|
|
pure virtual |
Set Network Activity indicator off.
- Note
- Not supported on all platforms.
◆ SetNetworkActivityIndicatorOn()
virtual void CYINetworkInformationBridge::SetNetworkActivityIndicatorOn |
( |
| ) |
|
|
pure virtual |
Set Network Activity indicator on.
- Note
- Not supported on all platforms.
◆ SetNetworkType()
virtual void CYINetworkInformationBridge::SetNetworkType |
( |
NetworkType |
networkType | ) |
|
|
pure virtual |
◆ StartNetworkStateListener()
virtual void CYINetworkInformationBridge::StartNetworkStateListener |
( |
| ) |
|
|
pure virtual |
Starts the network state listener.
◆ StopNetworkStateListener()
virtual void CYINetworkInformationBridge::StopNetworkStateListener |
( |
| ) |
|
|
pure virtual |
Stops the network state listener.
◆ MobileNetworkTypeChanged
Signals a change in mobile network state. The first parameter is the new state and the second parameter is the old state.
◆ NetworkStateChanged
Signals a change in network state. The first parameter is the new state and the second parameter is the old state.
The documentation for this class was generated from the following file: