Class RHTTPSession

class RHTTPSession;

Description

A session handle. A session is a set of HTTP transactions using the same connection settings (e.g. proxy) and the same set of filters. Multi-homing support provided by HTTP framework enables clients to specify Connection preferences through the session property EHttpSocketConnection.

Note that RHTTPSession (and consequently the whole of HTTP) depends on the active scheduler; a scheduler must be installed when the session is opened and it must be running if a transaction is actually to do anything.

Members

Defined in RHTTPSession:

• Close()Closes the session. All transactions will be stopped and closed
• ConnectL()Connect this WSP session. This function does nothing when called for text-mode.
• ConnectionInfo()constAccessor for the connection info for this session, and which is used for all tra...
• DisconnectL()Disconnect this WSP session. This function does nothing when called for text-mod...
• FailSessionEvent(THTTPFilterHandle)Fail the session event
• FilterCollection()constAccessor for the filter collection. Note that the filter collection can't be edi...
• GetTable()
• ListAvailableProtocolsL(RPointerArray< HBufC8 > &)This is a static methods that lists all the available protocols by adding the pr...
• OpenL()Opens the session using the default protocol HTTP/TCP. This function leaves with...
• OpenL(const TDesC8 &)Opens the session using the protocol indicated by the parameter passed in. This ...
• OpenL(const TDesC8 &,MHTTPFilterCreationCallback *)Opens the session using the protocol indicated by the parameter passed in. This ...
• OpenTransactionL(const TUriC8 &,MHTTPTransactionCallback &,RStringF)Creates a transaction.
• RHTTPSession()Constructor.
• RequestSessionHeadersL()Accessor for the session headers. These are headers that will get added to each ...
• ResponseSessionHeadersL()Accessor for the response session headers. These are headers that will get added...
• ServerCert(TCertInfo &)Obtain the server certificate information for this session. This function should...
• SetSessionEventCallback(MHTTPSessionEventCallback *)Sets the session event callback. Until it is set all incoming session events are...
• StringPool()constAccessor for the HTTP string pool.
• operator!=(RHTTPSession)constInequality operator
• operator==(RHTTPSession)constEquality operator.

See also:

• RHTTPTransactionA HTTP Transaction. This encapsulates 1 HTTP request and response. A Transaction...

inline RHTTPSession();

Description

Constructor.

Post-Condition

The session is closed. (It must be opened with OpenL)

See also:

• RHTTPSession::OpenL()Opens the session using the default protocol HTTP/TCP. This function leaves with...

IMPORT_C void SetSessionEventCallback(MHTTPSessionEventCallback *aSessionEventCallback);

Description

Sets the session event callback. Until it is set all incoming session events are consumed

Parameters

IMPORT_C void SendSessionEventL(THTTPSessionEvent aStatus, THTTPSessionEvent::TDirection aDirection, THTTPFilterHandle aStart=THTTPFilterHandle::EClient);

Description

Send an session event

Parameters

IMPORT_C void FailSessionEvent(THTTPFilterHandle aStart=THTTPFilterHandle::EClient);

Description

Fail the session event

Parameters

IMPORT_C void OpenL();

Pre-Condition

The session is closed. An active scheduler is installed.

Description

Opens the session using the default protocol HTTP/TCP. This function leaves with an apropriate code if the open failed.

Post-Condition

The session is open.

IMPORT_C void OpenL(const TDesC8 &aProtocol);

Pre-Condition

The session is closed. An active scheduler is installed.

Description

Opens the session using the protocol indicated by the parameter passed in. This function leaves with an apropriate code if the open failed.

Post-Condition

The session is open.

Parameters

IMPORT_C void OpenL(const TDesC8 &aProtocol, MHTTPFilterCreationCallback *aSessionCallback);

Pre-Condition

The session is closed. An active scheduler is installed.

Description

Opens the session using the protocol indicated by the parameter passed in. This method should be used if configuring the installed filters is required. Once construction if the session is complete the callback method passed in is called passing in a TFilterConfigurationIterator to allow the filters that are installed to be configured. This function leaves with an apropriate code if the open failed.

Post-Condition

The session is open.

Parameters

IMPORT_C static void ListAvailableProtocolsL(RPointerArray< HBufC8 > &aProtocolArray);

Description

This is a static methods that lists all the available protocols by adding the prorocol descriptors to the descriptor array passed in. Any existing data in the descriptor array passed in is deleted. This function leaves if the descriptor array can not be updated with the appropriate array code.

Parameters

See also:

• RHTTPSession::OpenL()Opens the session using the default protocol HTTP/TCP. This function leaves with...

IMPORT_C RHTTPTransaction OpenTransactionL(const TUriC8 &aURI, MHTTPTransactionCallback &aCallback, RStringF aMethod=RStringF());

Pre-Condition

The session is open

Description

Creates a transaction.

Parameters

Return value

Leave codes

IMPORT_C void Close();

Description

Closes the session. All transactions will be stopped and closed

Post-Condition

The session and all open transactions in it are closed.

IMPORT_C static const TStringTable& GetTable();

Description

Return value

IMPORT_C RStringPool StringPool() const;

Description

Accessor for the HTTP string pool.

Return value

IMPORT_C RHTTPConnectionInfo ConnectionInfo() const;

Description

Accessor for the connection info for this session, and which is used for all transactions in the session. Note that by and large, the connection info should be set up before the first transaction is created.

Return value

inline RHTTPFilterCollection FilterCollection() const;

Description

Accessor for the filter collection. Note that the filter collection can't be edited after the first transaction has been created.

Return value

IMPORT_C RHTTPHeaders RequestSessionHeadersL();

Description

Accessor for the session headers. These are headers that will get added to each request They only become part of the transaction headers when a transaction is submitted and they will not replace headers that already exist in the transaction request

Return value

IMPORT_C RHTTPHeaders ResponseSessionHeadersL();

Description

Accessor for the response session headers. These are headers that will get added to each response if the corresponding header doesn't already exist

Return value

inline TBool operator==(RHTTPSession aTrans) const;

Description

Equality operator.

Parameters

Return value

inline TBool operator!=(RHTTPSession aTrans) const;

Description

Inequality operator

Parameters

Return value

IMPORT_C TInt ServerCert(TCertInfo &aServerCert);

Description

Obtain the server certificate information for this session. This function should only be used for WSP, for text-mode use RHttpTransaction::ServerCert.

Parameters

Return value

IMPORT_C void ConnectL();

Description

Connect this WSP session. This function does nothing when called for text-mode.

IMPORT_C void DisconnectL();

Description

Disconnect this WSP session. This function does nothing when called for text-mode.