CYINetworkInformationBridge Class Reference

Detailed Description

CYINetworkInformationBridge contains functions relating to device network state.

#include <network/YiNetworkInformationBridge.h>

Public Types
enum	NETWORK_TYPE {   NO_CONNECTION,   WIFI,   MOBILE,   WIRED,   OTHER,   UNKNOWN }
enum	MOBILE_NETWORK_TYPE {   MOBILE_NETWORK_TYPE_NOT_APPLICABLE,   MOBILE_NETWORK_TYPE_2G,   MOBILE_NETWORK_TYPE_3G,   MOBILE_NETWORK_TYPE_4G,   MOBILE_NETWORK_TYPE_UNKNOWN }

Public Member Functions
virtual	~CYINetworkInformationBridge ()
virtual void	StartNetworkStateListener ()=0
virtual void	StopNetworkStateListener ()=0
virtual NETWORK_TYPE	GetNetworkType ()=0
virtual void	SetNetworkType (NETWORK_TYPE eNetworkType)=0
virtual MOBILE_NETWORK_TYPE	GetMobileNetworkType () const =0
virtual void	RefreshNetworkState ()=0
virtual CYIConnectivity &	GetConnectivity ()=0
virtual void	SetNetworkActivityIndicatorOn ()=0
virtual void	SetNetworkActivityIndicatorOff ()=0
virtual bool	HasNetworkStateListenerStarted ()=0
virtual bool	HasCellularNetworkSupport ()=0

Public Attributes
CYISignal< const CYINetworkInformationBridge::NETWORK_TYPE, const CYINetworkInformationBridge::NETWORK_TYPE >	NetworkStateChanged
CYISignal< const CYINetworkInformationBridge::MOBILE_NETWORK_TYPE, const CYINetworkInformationBridge::MOBILE_NETWORK_TYPE >	MobileNetworkTypeChanged

Member Enumeration Documentation

enum CYINetworkInformationBridge::MOBILE_NETWORK_TYPE

Enumerator
MOBILE_NETWORK_TYPE_NOT_APPLICABLE	The mobile network speed does not apply to the current connection type.
MOBILE_NETWORK_TYPE_2G	The mobile network speed is 2G.
MOBILE_NETWORK_TYPE_3G	The mobile network speed is 3G.
MOBILE_NETWORK_TYPE_4G	The mobile network speed is 4G.
MOBILE_NETWORK_TYPE_UNKNOWN	The mobile network speed is unknown.

enum CYINetworkInformationBridge::NETWORK_TYPE

The type of network connection reported by the device.

Enumerator
NO_CONNECTION	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.

Constructor & Destructor Documentation

virtual CYINetworkInformationBridge::~CYINetworkInformationBridge ( )

inlinevirtual

Member Function Documentation

virtual CYIConnectivity& CYINetworkInformationBridge::GetConnectivity ( )

pure virtual

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.

virtual MOBILE_NETWORK_TYPE CYINetworkInformationBridge::GetMobileNetworkType ( ) const

pure virtual

Returns the current CYINetworkInformationBridge::MOBILE_NETWORK_TYPE if the network type is mobile; CYINetworkInformationBridge::MOBILE_NETWORK_TYPE_NOT_APPLICABLE otherwise.

virtual NETWORK_TYPE CYINetworkInformationBridge::GetNetworkType ( )

pure virtual

Returns the current CYINetworkInformationBridge::NETWORK_TYPE.

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)

virtual bool CYINetworkInformationBridge::HasNetworkStateListenerStarted ( )

pure virtual

Returns true if the network state listener has started and false otherwise.

virtual void CYINetworkInformationBridge::RefreshNetworkState ( )

pure virtual

Refreshes the network state using the current network state.

virtual void CYINetworkInformationBridge::SetNetworkActivityIndicatorOff ( )

pure virtual

Set Network Activity indicator off.

Note

Not supported on all platforms.

virtual void CYINetworkInformationBridge::SetNetworkActivityIndicatorOn ( )

pure virtual

Set Network Activity indicator on.

Note

Not supported on all platforms.

virtual void CYINetworkInformationBridge::SetNetworkType ( NETWORK_TYPE  eNetworkType )

pure virtual

Sets the CYINetworkInformationBridge::NETWORK_TYPE.

virtual void CYINetworkInformationBridge::StartNetworkStateListener ( )

pure virtual

Starts the network state listener.

virtual void CYINetworkInformationBridge::StopNetworkStateListener ( )

pure virtual

Stops the network state listener.

Member Data Documentation

CYISignal<const CYINetworkInformationBridge::MOBILE_NETWORK_TYPE , const CYINetworkInformationBridge::MOBILE_NETWORK_TYPE > CYINetworkInformationBridge::MobileNetworkTypeChanged

Signals a change in mobile network state. The first parameter is the new state and the second parameter is the old state.

CYISignal<const CYINetworkInformationBridge::NETWORK_TYPE , const CYINetworkInformationBridge::NETWORK_TYPE > CYINetworkInformationBridge::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:

• network/YiNetworkInformationBridge.h