GprsConnection Class Reference

GPRS connection class. More...

#include <GprsConnection.h>

Inheritance diagram for GprsConnection:
NetworkConnection PowerEventListener Thread EventBroadcaster< NetworkEventListener >

List of all members.

Public Member Functions

 GprsConnection (GPRS_CONNECTION_SETTINGS *pSettings)
 Class constructor.
virtual ~GprsConnection ()
 Class destructor.
GsmModulegetGsmModule ()
 Get GSM module object.
virtual bool isConnectionUp ()
 Returns the status of the connection.
virtual bool getNetworkInfo (GENERIC_NETWORK_INFO &netInfo)
 Get information about the network Get general information about the network (i.e. signal strength etc.).

Protected Member Functions

virtual bool netInitialize ()
 Initialize the GPRS module.
virtual bool netConnect ()
 Establishes the data connection.
virtual bool netDisconnect ()
 Terminates the PPP connection Closes the PPP connection with the service provider.
virtual bool netSuspend ()
 Temporarily suspends the GPRS connection Shuts down the GPRS command channel and terminates the PPP connection for power saving reasons. It can be re-established with netResume() method.
virtual bool netResume ()
 Resumes the connection Resumes the GPRS connection from previously suspended state.
virtual bool netShutdown ()
 Shuts down the GPRS module Shuts down and powers off the GPRS module and multiplexer.

Detailed Description

GPRS connection class.

Implements the GPRS network connection. Currently supported is the Artec GSM/GPRS mini-PCI express card with Telit GE864 modem.


Constructor & Destructor Documentation

GprsConnection::GprsConnection ( GPRS_CONNECTION_SETTINGS pSettings  ) 

Class constructor.

Initializes the GPRS network connection object.

Parameters:
pSettings Points to a structure containing the GPRS configuration parameters. The data is copied to a local storage.
GprsConnection::~GprsConnection (  )  [virtual]

Class destructor.

Terminates the GPRS network connection object.


Member Function Documentation

GsmModule * GprsConnection::getGsmModule (  ) 

Get GSM module object.

Returns:
Returns the pointer to the GSM/GPRS module object encapsulated by this network connection class.
bool GprsConnection::getNetworkInfo ( GENERIC_NETWORK_INFO netInfo  )  [virtual]

Get information about the network Get general information about the network (i.e. signal strength etc.).

Parameters:
netInfo Structure where the information will be stored
Returns:
Returns true if the information was successfully stored

Implements NetworkConnection.

bool GprsConnection::isConnectionUp (  )  [virtual]

Returns the status of the connection.

Returns:
Returns true, if connection is active, false otherwise

Implements NetworkConnection.

bool GprsConnection::netConnect (  )  [protected, virtual]

Establishes the data connection.

Establishes the PPP data connection with the service provider

Returns:
Returns true, if the connection was established successfully

Implements NetworkConnection.

bool GprsConnection::netDisconnect (  )  [protected, virtual]

Terminates the PPP connection Closes the PPP connection with the service provider.

Returns:
Returns true if the connection was terminated successfully

Implements NetworkConnection.

bool GprsConnection::netInitialize (  )  [protected, virtual]

Initialize the GPRS module.

Initializes the GPRS module and connects to the provider network. The data connection must be opened separately by calling netConnect().

This should be done before the application is fully loaded

Returns:
Returns true if initialization was successful and modem is working, false otherwise.

Implements NetworkConnection.

bool GprsConnection::netResume (  )  [protected, virtual]

Resumes the connection Resumes the GPRS connection from previously suspended state.

Returns:
Returns true if the resume was successful

Reimplemented from NetworkConnection.

bool GprsConnection::netShutdown (  )  [protected, virtual]

Shuts down the GPRS module Shuts down and powers off the GPRS module and multiplexer.

Returns:
Returns true if power down was successful

Implements NetworkConnection.

bool GprsConnection::netSuspend (  )  [protected, virtual]

Temporarily suspends the GPRS connection Shuts down the GPRS command channel and terminates the PPP connection for power saving reasons. It can be re-established with netResume() method.

Returns:
Returns true if the suspend was successful

Reimplemented from NetworkConnection.


The documentation for this class was generated from the following files:
Generated on Wed Oct 20 11:13:44 2010 for libspatha by  doxygen 1.6.3