Contents

• Public Types
• Public Functions
• Public Slots
• Signals
• Detailed Description
• Roaming

Detailed Description

TheQNetworkSession class provides control over the system's access points and enables session management for cases when multiple clients access the same access point.

AQNetworkSession enables control over the system's network interfaces. The session's configuration parameter are determined via theQNetworkConfiguration object to which it is bound. Depending on the type of the session (single access point or service network) a session may be linked to one or more network interfaces. By means ofopening andclosing of network sessions a developer can start and stop the systems network interfaces. If the configuration represents multiple access points (seeQNetworkConfiguration::ServiceNetwork) more advanced features such as roaming may be supported.

QNetworkSession supports session management within the same process and depending on the platform's capabilities may support out-of-process sessions. If the same network configuration is used by multiple open sessions the underlying network interface is only terminated once the last session has been closed.

Roaming

Applications may connect to thepreferredConfigurationChanged() signal in order to receive notifications when a more suitable access point becomes available. In response to this signal the application must either initiate the roaming viamigrate() orignore() the new access point. Once the session has roamed thenewConfigurationActivated() signal is emitted. The application may now test the carrier and must eitheraccept() orreject() it. The session will return to the previous access point if the roaming was rejected. The subsequent state diagram depicts the required state transitions.

Some platforms may distinguish forced roaming and application level roaming (ALR). ALR implies that the application controls (viamigrate(),ignore(),accept() andreject()) whether a network session can roam from one access point to the next. Such control is useful if the application maintains stateful socket connections and wants to control the transition from one interface to the next. Forced roaming implies that the system automatically roams to the next network without consulting the application. This has the advantage that the application can make use of roaming features without actually being aware of it. It is expected that the application detects that the underlying socket is broken and automatically reconnects via the new network link.

If the platform supports both modes of roaming, an application indicates its preference by connecting to thepreferredConfigurationChanged() signal. Connecting to this signal means that the application wants to take control over the roaming behavior and therefore implies application level roaming. If the client does not connect to thepreferredConfigurationChanged(), forced roaming is used. If forced roaming is not supported the network session will not roam by default.

Some applications may want to suppress any form of roaming altogether. Possible use cases may be high priority downloads or remote services which cannot handle a roaming enabled client. Clients can suppress roaming by connecting to thepreferredConfigurationChanged() signal and answer each signal emission withignore().

Member Type Documentation

enum QNetworkSession::SessionError

This enum describes the session errors that can occur.

enum QNetworkSession::State

This enum describes the connectivity state of the session. If the session is based on a single access point configuration the state of the session is the same as the state of the associated network interface.

Member Function Documentation

QNetworkSession::QNetworkSession(constQNetworkConfiguration & connectionConfig,QObject * parent = 0)

Constructs a session based onconnectionConfig with the givenparent.

See alsoQNetworkConfiguration.

[virtual]QNetworkSession::~QNetworkSession()

Frees the resources associated with theQNetworkSession object.

[slot]void QNetworkSession::accept()

Instructs the session to permanently accept the new access point. Once this function has been called the session may not return to the old access point.

The old access point may be closed in the process if there are no other network sessions for it. Therefore any open socket that still uses the old access point may become unusable and should be closed before completing the migration.

quint64 QNetworkSession::activeTime() const

Returns the number of seconds that the session has been active.

quint64 QNetworkSession::bytesReceived() const

Returns the amount of data received in bytes; otherwise 0.

This field value includes the usage across all open network sessions which use the same network interface.

If the session is based on a service network configuration the number of sent bytes across all active member configurations are returned.

This function may not always be supported on all platforms and returns 0. The platform capability can be detected viaQNetworkConfigurationManager::DataStatistics.

Note:On some platforms this function may run the main event loop.

quint64 QNetworkSession::bytesWritten() const

Returns the amount of data sent in bytes; otherwise 0.

This field value includes the usage across all open network sessions which use the same network interface.

If the session is based on a service network configuration the number of sent bytes across all active member configurations are returned.

This function may not always be supported on all platforms and returns 0. The platform capability can be detected viaQNetworkConfigurationManager::DataStatistics.

Note:On some platforms this function may run the main event loop.

[slot]void QNetworkSession::close()

Decreases the session counter on the associated network configuration. If the session counter reaches zero the active network interface is shut down. This also means thatstate() will only change fromConnected toDisconnected if the current session was the last open session.

If the platform does not support out-of-process sessions calling this function does not stop the interface. In this casestop() has to be used to force a shut down. The platform capabilities can be detected viaQNetworkConfigurationManager::capabilities().

Note that this call is asynchronous. Depending on the outcome of this call the results can be enquired by connecting to thestateChanged(),opened() orerror() signals.

See alsoopen(),stop(), andisOpen().

[signal]void QNetworkSession::closed()

This signal is emitted when the network session has been closed.

QNetworkConfiguration QNetworkSession::configuration() const

Returns theQNetworkConfiguration that this network session object is based on.

See alsoQNetworkConfiguration.

SessionError QNetworkSession::error() const

Returns the type of error that last occurred.

See alsostate() anderrorString().

[signal]void QNetworkSession::error(QNetworkSession::SessionError error)

This signal is emitted after an error occurred. Theerror parameter describes the error that occurred.

Note:Signalerror is overloaded in this class. To connect to this one using the function pointer syntax, you must specify the signal type in a static cast, as shown in this example:

connect(networkSession,static_cast<void(QNetworkSession::*)(QNetworkSession::SessionError)>(&QNetworkSession::error),[=](QNetworkSession::SessionError error){/* ... */ });

See alsoerror() anderrorString().

QString QNetworkSession::errorString() const

Returns a human-readable description of the last device error that occurred.

See alsoerror().

[slot]void QNetworkSession::ignore()

This function indicates that the application does not wish to roam the session.

See alsomigrate().

QNetworkInterface QNetworkSession::interface() const

Returns the network interface that is used by this session.

This function only returns a validQNetworkInterface when this session isConnected.

The returned interface may change as a result of a roaming process.

Note: this function does not work in Symbian emulator due to the way the connectivity is emulated on Windows.

See alsostate().

bool QNetworkSession::isOpen() const

Returns true if this session is open. If the number of all open sessions is greater than zero the underlying network interface will remain connected/up.

The session can be controlled viaopen() andclose().

[slot]void QNetworkSession::migrate()

Instructs the session to roam to the new access point. The old access point remains active until the application callsaccept().

ThenewConfigurationActivated() signal is emitted once roaming has been completed.

See alsoaccept().

[signal]void QNetworkSession::newConfigurationActivated()

This signal is emitted once the session has roamed to the new access point. The application may reopen its socket and test the suitability of the new network link. Subsequently it must eitheraccept() orreject() the new access point.

See alsoaccept() andreject().

[slot]void QNetworkSession::open()

Creates an open session which increases the session counter on the underlying network interface. The system will not terminate a network interface until the session reference counter reaches zero. Therefore an open session allows an application to register its use of the interface.

As a result of calling open() the interface will be started if it is not connected/up yet. Some platforms may not provide support for out-of-process sessions. On such platforms the session counter ignores any sessions held by another process. The platform capabilities can be detected viaQNetworkConfigurationManager::capabilities().

Note that this call is asynchronous. Depending on the outcome of this call the results can be enquired by connecting to thestateChanged(),opened() orerror() signals.

It is not a requirement to open a session in order to monitor the underlying network interface.

See alsoclose(),stop(), andisOpen().

[signal]void QNetworkSession::opened()

This signal is emitted when the network session has been opened.

The underlying network interface will not be shut down as long as the session remains open. Note that this feature is dependent onsystem wide session support.

[signal]void QNetworkSession::preferredConfigurationChanged(constQNetworkConfiguration & config,bool isSeamless)

This signal is emitted when the preferred configuration/access point for the session changes. Only sessions which are based on service network configurations may emit this signal.config can be used to determine access point specific details such as proxy settings andisSeamless indicates whether roaming will break the sessions IP address.

As a consequence to this signal the application must either start the roaming process by callingmigrate() or choose toignore() the new access point.

If the roaming process is non-seamless the IP address will change which means that a socket becomes invalid. However seamless mobility can ensure that the local IP address does not change. This is achieved by using a virtual IP address which is bound to the actual link address. During the roaming process the virtual address is attached to the new link address.

Some platforms may support the concept of Forced Roaming and Application Level Roaming (ALR). Forced roaming implies that the platform may simply roam to a new configuration without consulting applications. It is up to the application to detect the link layer loss and reestablish its sockets. In contrast ALR provides the opportunity to prevent the system from roaming. If this session is based on a configuration that supports roaming the application can choose whether it wants to be consulted (ALR use case) by connecting to this signal. For as long as this signal connection remains the session remains registered as a roaming stakeholder; otherwise roaming will be enforced by the platform.

See alsomigrate(),ignore(), andQNetworkConfiguration::isRoamingAvailable().

[slot]void QNetworkSession::reject()

The new access point is not suitable for the application. By calling this function the session returns to the previous access point/configuration. This action may invalidate any socket that has been created via the not desired access point.

See alsoaccept().

QVariant QNetworkSession::sessionProperty(constQString & key) const

Returns the value for propertykey.

A network session can have properties attached which may describe the session in more details. This function can be used to gain access to those properties.

The following property keys are guaranteed to be specified on all platforms:

QNetworkConfigurationManager mgr;QNetworkConfiguration ap= mgr.defaultConfiguration();QNetworkSession*session=newQNetworkSession(ap);...//code activates sessionQString ident= session->sessionProperty("ActiveConfiguration").toString();if ( ap.type()==QNetworkConfiguration::ServiceNetwork ) {    Q_ASSERT( ap.identifier()!= ident );    Q_ASSERT( ap.children().contains( mgr.configurationFromIdentifier(ident) ) );}elseif ( ap.type()==QNetworkConfiguration::InternetAccessPoint ) {    Q_ASSERT( ap.identifier()== ident );}

See alsosetSessionProperty().

void QNetworkSession::setSessionProperty(constQString & key, constQVariant & value)

Sets the propertyvalue on the session. The property is identified usingkey. Removing an already set property can be achieved by passing an invalidQVariant.

Note that theUserChoiceConfiguration andActiveConfiguration properties are read only and cannot be changed using this method.

See alsosessionProperty().

State QNetworkSession::state() const

Returns the state of the session.

If the session is based on a single access point configuration the state of the session is the same as the state of the associated network interface. Therefore a network session object can be used to monitor network interfaces.

AQNetworkConfiguration::ServiceNetwork based session summarizes the state of all its children and therefore returns theConnected state if at least one of the service network'schildren() configurations is active.

Note that it is not required to hold an open session in order to obtain the network interface state. A connected but closed session may be used to monitor network interfaces whereas an open and connected session object may prevent the network interface from being shut down.

See alsoerror() andstateChanged().

[signal]void QNetworkSession::stateChanged(QNetworkSession::State state)

This signal is emitted whenever the state of the network session changes. Thestate parameter is the new state.

See alsostate().

[slot]void QNetworkSession::stop()

Invalidates all open sessions against the network interface and therefore stops the underlying network interface. This function always changes the session'sstate() flag toDisconnected.

On Symbian platform, a 'NetworkControl' capability is required for full interface-level stop (without the capability, only the current session is stopped).

See alsoopen() andclose().

bool QNetworkSession::waitForOpened(int msecs = 30000)

Waits until the session has been opened, up tomsecs milliseconds. If the session has been opened, this function returns true; otherwise it returns false. In the case where it returns false, you can callerror() to determine the cause of the error.

The following example waits up to one second for the session to be opened:

session->open();if (session->waitForOpened(1000))qDebug("Open!");

Ifmsecs is -1, this function will not time out.

See alsoopen() anderror().