Maps SDK for C++ 1.0.0
Loading...
Searching...
No Matches
gem::INetworkProvider Class Referenceabstract

Network access customization. More...

Public Member Functions

virtual void setListener (INetworkListener *listener)=0
 Sets the network listener.
virtual int connect ()=0
 Request network connection.
virtual int disconnect ()=0
 Disconnect the network if connected.
virtual void connectionError (const String &host)
 Connection error notification.
virtual String getPublicIp ()
 Get public Ip from.

Detailed Description

Network access customization.

Member Function Documentation

◆ connect()

virtual int gem::INetworkProvider::connect ( )
pure virtual

Request network connection.

When the request execution finishes, the INetworkListener::OnConnectFinished is called.

Returns
KNoError The request was successfully sent to the network service.
error::KNoConnection No access point available.
error::KRequired There is no listener attached.

◆ connectionError()

virtual void gem::INetworkProvider::connectionError ( const String & host)
inlinevirtual

Connection error notification.

Possible causes: network down, application doesn't permit to access the network

Parameters
[in]hostHost name which cannot be reached

◆ disconnect()

virtual int gem::INetworkProvider::disconnect ( )
pure virtual

Disconnect the network if connected.

No notification is provided.

Returns
KNoError Success
error::KNotFound There was no connection.

◆ getPublicIp()

virtual String gem::INetworkProvider::getPublicIp ( )
inlinevirtual

Get public Ip from.

This information is useful when the SDK sends a connection exception debug info. If user considers this info as private, then this function should not be implemented/overridden

Returns
Public IP address

◆ setListener()

virtual void gem::INetworkProvider::setListener ( INetworkListener * listener)
pure virtual

Sets the network listener.

Parameters
listenerThe listener to set.