IoT::MobileConnection

class MobileConnectionServiceRemoteObject

File Information

Library: IoT/MobileConnection
Package: Generated
Header: IoT/MobileConnection/MobileConnectionServiceRemoteObject.h

Description

The MobileConnectionService interface is used to configure and establish a mobile data connection.

Inheritance

Direct Base Classes: IMobileConnectionService, Poco::RemotingNG::RemoteObject

All Base Classes: IMobileConnectionService, Poco::OSP::Service, Poco::RefCountedObject, Poco::RemotingNG::Identifiable, Poco::RemotingNG::RemoteObject

Member Summary

Member Functions: authenticate, connectData, deviceName, disconnectData, enableRadio, enterPIN, event__dataConnected, event__dataDisconnected, getAPN, getPDPType, iccid, imei, imsi, isDataConnected, isRadioEnabled, lockSIM, networkOperator, phoneNumber, radioAccessTechnology, registrationStatus, remoting__enableEvents, remoting__enableRemoteEvents, remoting__hasEvents, remoting__typeId, setAPN, setPDPType, signalStrength, simState, unlockSIM

Inherited Functions: authenticate, connectData, deviceName, disconnectData, duplicate, enableRadio, enterPIN, getAPN, getPDPType, iccid, imei, imsi, isA, isDataConnected, isRadioEnabled, lockSIM, mutex, networkOperator, phoneNumber, radioAccessTechnology, referenceCount, registrationStatus, release, remoting__enableEvents, remoting__enableRemoteEvents, remoting__getURI, remoting__hasEvents, remoting__objectId, remoting__setURI, remoting__typeId, setAPN, setPDPType, signalStrength, simState, type, unlockSIM

Types Aliases

Ptr

using Ptr = Poco::AutoPtr < MobileConnectionServiceRemoteObject >;

Constructors

MobileConnectionServiceRemoteObject

MobileConnectionServiceRemoteObject(
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    Poco::SharedPtr < IoT::MobileConnection::MobileConnectionService > pServiceObject
);

Creates a MobileConnectionServiceRemoteObject.

Destructor

~MobileConnectionServiceRemoteObject virtual

virtual ~MobileConnectionServiceRemoteObject();

Destroys the MobileConnectionServiceRemoteObject.

Member Functions

authenticate virtual inline

virtual void authenticate(
    IoT::MobileConnection::AuthMethod method,
    const std::string & username,
    const std::string & password
);

Provide the credentials for the mobile data connection.

See also: IoT::MobileConnection::IMobileConnectionService::authenticate()

connectData virtual inline

virtual void connectData();

Establishes the data connection.

See also: IoT::MobileConnection::IMobileConnectionService::connectData()

deviceName virtual inline

virtual std::string deviceName() const;

Returns the modem device name.

See also: IoT::MobileConnection::IMobileConnectionService::deviceName()

disconnectData virtual inline

virtual void disconnectData();

Closes the data connection.

See also: IoT::MobileConnection::IMobileConnectionService::disconnectData()

enableRadio virtual inline

virtual void enableRadio(
    bool enable
);

Enables or disables the radio.

See also: IoT::MobileConnection::IMobileConnectionService::enableRadio()

enterPIN virtual inline

virtual void enterPIN(
    const std::string & pin
);

Provides the given PIN to the SIM.

See also: IoT::MobileConnection::IMobileConnectionService::enterPIN()

getAPN virtual inline

virtual std::string getAPN() const;

Returns the configured Access Point Name (APN) for the mobile data connection.

See also: IoT::MobileConnection::IMobileConnectionService::getAPN()

getPDPType virtual inline

IoT::MobileConnection::PDPType getPDPType() const;

Returns the PDP Type for the mobile data connection.

See also: IoT::MobileConnection::IMobileConnectionService::getPDPType()

iccid virtual inline

virtual std::string iccid() const;

Returns the SIMs ICCID (Integrated Circuit Card Identifier).

See also: IoT::MobileConnection::IMobileConnectionService::iccid()

imei virtual inline

virtual std::string imei() const;

Returns the IMEI (International Mobile Equipment Identity).

See also: IoT::MobileConnection::IMobileConnectionService::imei()

imsi virtual inline

virtual std::string imsi() const;

Returns the SIM's IMSI (International Mobile Subscriber Identity).

See also: IoT::MobileConnection::IMobileConnectionService::imsi()

isDataConnected virtual inline

virtual bool isDataConnected();

Returns true if the data connection is available.

See also: IoT::MobileConnection::IMobileConnectionService::isDataConnected()

isRadioEnabled virtual inline

virtual bool isRadioEnabled() const;

Returns true if the radio is enabled, otherwise false.

See also: IoT::MobileConnection::IMobileConnectionService::isRadioEnabled()

lockSIM virtual inline

virtual void lockSIM(
    const std::string & pin
);

Locks the SIM, using the given PIN.

See also: IoT::MobileConnection::IMobileConnectionService::lockSIM()

networkOperator virtual inline

virtual std::string networkOperator() const;

Returns the name of the network operator, if available, or an empty string otherwise.

See also: IoT::MobileConnection::IMobileConnectionService::networkOperator()

phoneNumber virtual inline

virtual std::string phoneNumber() const;

Returns the phone number associated with the SIM.

See also: IoT::MobileConnection::IMobileConnectionService::phoneNumber()

radioAccessTechnology virtual inline

IoT::MobileConnection::RadioAccessTechnology radioAccessTechnology() const;

Returns the radio access technology (RAT) used to connect to the mobile network.

See also: IoT::MobileConnection::IMobileConnectionService::radioAccessTechnology()

registrationStatus virtual inline

IoT::MobileConnection::RegistrationStatus registrationStatus() const;

Returns the network registration status.

See also: IoT::MobileConnection::IMobileConnectionService::registrationStatus()

remoting__enableEvents virtual

virtual std::string remoting__enableEvents(
    Poco::RemotingNG::Listener::Ptr pListener,
    bool enable = bool (true)
);

See also: IoT::MobileConnection::IMobileConnectionService::remoting__enableEvents()

remoting__enableRemoteEvents virtual

virtual void remoting__enableRemoteEvents(
    const std::string & protocol
);

See also: Poco::RemotingNG::RemoteObject::remoting__enableRemoteEvents()

remoting__hasEvents virtual

virtual bool remoting__hasEvents() const;

See also: Poco::RemotingNG::RemoteObject::remoting__hasEvents()

remoting__typeId virtual inline

virtual const Poco::RemotingNG::Identifiable::TypeId & remoting__typeId() const;

setAPN virtual inline

virtual void setAPN(
    const std::string & apn
);

Sets the Access Point Name (APN) for the mobile data connection.

See also: IoT::MobileConnection::IMobileConnectionService::setAPN()

setPDPType virtual inline

virtual void setPDPType(
    IoT::MobileConnection::PDPType type
);

Sets the PDP Type for the mobile data connection.

See also: IoT::MobileConnection::IMobileConnectionService::setPDPType()

signalStrength virtual inline

virtual int signalStrength() const;

Returns the signal strength in a range from 0 to 5 (suitable for displaying corresponding "signal strength bars").

  • 0: No signal.
  • 1: Very weak signal.
  • 2: Weak signal strength.
  • 3: Good signal strength.
  • 4: Strong signal strength.
  • 5: Very strong signal strength.

Returns -1 if the signal strength cannot be obtained.

See also: IoT::MobileConnection::IMobileConnectionService::signalStrength()

simState virtual inline

IoT::MobileConnection::SIMState simState() const;

Returns the current state of the SIM.

See also: IoT::MobileConnection::IMobileConnectionService::simState()

unlockSIM virtual inline

virtual void unlockSIM(
    const std::string & pin
);

Unlocks the SIM, using the given PIN.

See also: IoT::MobileConnection::IMobileConnectionService::unlockSIM()

event__dataConnected protected

void event__dataConnected();

event__dataDisconnected protected

void event__dataDisconnected();

Securely control IoT edge devices from anywhere   Connect a Device