Symbian
 Developer Library

DEVELOPER LIBRARY

[Index] [Glossary] [Previous] [Next]



Location: http\thttpevent.h
Link against: http.lib

Class THTTPSessionEvent

class THTTPSessionEvent

Support

Supported from 7.0

Description

A transport framework session event message.

This derives from THTTPEvent to add support for session events.

Derivation

THTTPEventA transport framework event message
THTTPSessionEventA transport framework session event message

Defined in THTTPSessionEvent:
EAlreadyConnected, EAlreadyConnecting, EAlreadyDisconnected, EAlreadyDisconnecting, EAuthenticatedOK, EAuthenticationFailure, EConnect, EConnectedOK, EConnectedWithReducedCapabilities, EConnectionTimedOut, EDisconnect, EDisconnected, EExceptionInfo, ENotConnected, ERedirected, THTTPSessionEvent(), THTTPSessionEvent(), THTTPSessionEvent(), TSessionEvent, TSessionWarning, operator!=(), operator=(), operator==()

Inherited from THTTPEvent:
EAll, EAnySessionEvent, EAnyTransactionEvent, ECancel, EClosed, EFailed, EGotResponseBodyData, EGotResponseHeaders, EGotResponseTrailerHeaders, EIncoming, EMoreDataReceivedThanExpected, ENotifyNewRequestBodyPart, EOutgoing, ERedirectedPermanently, ERedirectedTemporarily, EResponseComplete, ESubmit, ESucceeded, ETooMuchRequestData, EUnrecoverableError, IsSessionEvent(), TDirection, TStandardEvent, TTransactionEvent, TTransactionWarning, iIsSessionEventFlag, iStatus, iUID


Construction


THTTPSessionEvent()

inline THTTPSessionEvent(TInt aStatus, TUint aUID=KHTTPUid);

Description

Constructor specifying a status value and a UID.

Parameters

TInt aStatus

Status value

TUint aUID

UID, defaults to the HTTP transport


THTTPSessionEvent()

inline THTTPSessionEvent(TStandardEvent aStatus=EAnySessionEvent);

Description

Constructor specifying a standard event type, and defaulting to the HTTP UID.

Parameters

TStandardEvent aStatus

Standard event type


THTTPSessionEvent()

inline THTTPSessionEvent(TSessionEvent aStatus);

Description

Constructor, specifying a session event code, and defaulting to the HTTP UID.

Parameters

TSessionEvent aStatus

Status value

[Top]


Member Enumerations


Enum TSessionEvent

TSessionEvent

Description

Defines the events that relate to a session.

Outgoing session events originate from the client or from filters. Incoming session events originate from the protocol handler or from filters, and clients should handle these.

EConnect

A session connection should be initiated. An outgoing event.

EDisconnect

The session should be disconnected. An outgoing event.

EConnectedOK

The session has been successfully connected, and none of the client requested capabilities were denied or reduced by the proxy. An incoming event.

EConnectedWithReducedCapabilities

The session has been connected, but with one or more of tnt requested capabilities denied or reduced by the proxy. An incoming event.

EDisconnected

The session has been disconnected. An incoming event.

This either confirms an earlier EDisconnect event or indicates a forced disconnection by the proxy.

EAuthenticatedOK

The authentication handshake succeeded with the automatic validation of the (proxy) server certificate.

EAuthenticationFailure

The authentication handshake failed.

EConnectionTimedOut

The connection attempt to the proxy timed out.


Enum TSessionWarning

TSessionWarning

Description

Session warnings.

ENotConnected

The client has requested a transaction event that requires a session to be connected or the connection to be initiated, but neither is currently true.

The transaction event will be left pending until the session is connected. An incoming event.

EExceptionInfo

The proxy has sent some information that is not related to a transaction and has no effect on the state of the session.

The information from the proxy is in the EProxyExceptionInfo property.

ERedirected

The client connection request was (permanently) redirected to a new WAP proxy address.

The client should check the EWspProxyAddress property for the new address. The client's access-point database can then be updated with this address. No notification is given of a temporary redirection.

EAlreadyConnecting

The client has requested a session event that is not valid while the WSP session is in the Connected state.

EAlreadyConnected

The client has requested a session event that is not valid while the WSP session is trying to close the connection.

EAlreadyDisconnecting

The client has requested a session event that is not valid while the WSP session is trying to close the connection.

EAlreadyDisconnected

The client has requested a session event that is not valid while the WSP session is in the Null (or disconnected) state.

[Top]


Member Functions


operator=()

inline THTTPSessionEvent& operator=(TSessionEvent aStatus);

Description

Assigns a session event code to an event object.

Parameters

TSessionEvent aStatus

The session event.

Return value

THTTPSessionEvent &

Event after assignment


operator==()

inline TBool operator ==(TSessionEvent aStatus) const;

Description

Equality operator for comparison against a session event.

Parameters

TSessionEvent aStatus

Event to compare against

Return value

TBool

ETrue if equal, else EFalse


operator!=()

inline TBool operator !=(TSessionEvent aStatus) const;

Description

Inequality operator for comparison against a session event.

Parameters

TSessionEvent aStatus

Event to compare against

Return value

TBool

ETrue if unequal, else EFalse