Class CWspTransportHandler

class CWspTransportHandler

Support

Supported from 7.0

Description

ECom WSP Transport Handler plug-in interface.

A WSP Transport Handler plug-in provides its client with WSP services. It allows the client to be independent of the particular WAP protocol stack implementation which the plug-in uses.

A plug-in can offer five distinct services, each associated with an abstract interface that the plug-in can implement:

• MWspCOSessionInvoker, a Connection-Oriented Session service

• MWspCOMethodInvoker, a Connection-Oriented Transaction service

• MWspCOPushInvoker, a Connection-Oriented Push service

• MWspCLMethodInvoker, a Connection-Less Session service

• MWspCLPushInvoker, a Connection-Less Push service

Specific implementations may offer some or all of the five services.

All implementations must also provide default security policy settings via the MSecurityPolicy interface. The defaults shall be used when no security policy plug-in is supplied by the caller of CWspTransportHandler::NewL(). This might occur if the plug-in could not be located on the device.

Derivation

CBase Base class for all classes to be instantiated on the heap CWspTransportHandler ECom WSP Transport Handler plug-in interface MSecurityPolicy The Security Policy Interface

Defined in CWspTransportHandler:
CLMethodInvoker(), CLPushInvoker(), COPushInvoker(), COSessionInvoker(), COTransactionInvoker(), CWspTransportHandler(), ECLPushService, ECLSessionService, ECOMethodInvocationService, ECOPushService, ECOSessionService, NewL(), SInstantiationParams, ServerCert(), SupportedServices(), TWspService, TWspSupportedServices, iCapProv, iDtor_ID_Key, iProxyInfoProv, iSecurityPolicy, iSessHdrProv, iSessionCB, iStringPool, ~CWspTransportHandler()

Inherited from CBase:
operator new()

Inherited from MSecurityPolicy:
CancelValidateUntrustedServerCert(), GetNamedPolicyProperty(), GetTlsCipherSuites(), GetWtlsCipherSuites(), GetWtlsKeyExchangeSuites(), Reserved1(), Reserved2(), ValidateUntrustedServerCert()

inline static CWspTransportHandler* NewL(RStringPool aStringPool, MSecurityPolicy* aSecurityPolicy, MWspCOSessionCallback& aSessionCB, MWspProxyInfoProvider& aProxyInfoProv, MWspCapabilityProvider& aCapProv, MWspSessionHeadersProvider& aSessHdrProv);

Description

ECom factory function that instantiates a transport handler plug-in.

The plug-in's NewL() functions gets these parameters encapsulated in a SInstantiationParams object.

Parameters

RStringPool aStringPool Handle for a string pool used by the WSP transport handler plug-in MSecurityPolicy* aSecurityPolicy (in) A security policy provider. This can be NULL. const MWspCOSessionCallback& aSessionCB The client's callback for session events const MWspProxyInfoProvider& aProxyInfoProv The client's provider of proxy information const MWspCapabilityProvider& aCapProv The client's provider of capabilities information const MWspSessionHeadersProvider& aSessHdrProv The client's provider of session headers

Return value

CWspTransportHandler* The new CWspTransportHandler object

protected: inline CWspTransportHandler(RStringPool aStringPool, MSecurityPolicy* aSecurityPolicy, MWspCOSessionCallback& aSessionCB, MWspProxyInfoProvider& aProxyInfoProv, MWspCapabilityProvider& aCapProv, MWspSessionHeadersProvider& aSessHdrProv);

Description

Constructor that initialises data members.

Parameters

RStringPool aStringPool Handle for a string pool used by the WSP transport handler plug-in MSecurityPolicy* aSecurityPolicy (in) A security policy provider. This can be NULL. const MWspCOSessionCallback& aSessionCB The client's callback for session events const MWspProxyInfoProvider& aProxyInfoProv The client's provider of proxy information const MWspCapabilityProvider& aCapProv The client's provider of capabilities information const MWspSessionHeadersProvider& aSessHdrProv The client's provider of session headers

inline virtual ~CWspTransportHandler();

Description

Destructor.

virtual TWspSupportedServices SupportedServices() const = 0;

Description

Queries the services supported by this instantiation of the WSP transport handler plug-in.

Return value

TWspSupportedServices A union of flags describing the services supported by the WSP transport handler

virtual TInt ServerCert(TCertInfo& aCertInfo) const = 0;

Description

Gets the Server Certificate for the current session.

Parameters

TCertInfo& aCertInfo A TCertInfo that on return contains the certificate information

Return value

TInt An error code. KErrNone if aServerCert has been completed, otherwise one of the system wide error codes.

virtual MWspCOSessionInvoker& COSessionInvoker()=0;

Description

Gets the connection-oriented session invocation interface.

Return value

MWspCOSessionInvoker& Interface to be used by the client for CO session invocations

Panic codes

This function will panic if the service isn't supported by a particular implementation of the API.

virtual MWspCOMethodInvoker& COTransactionInvoker()=0;

Description

Gets the connection-oriented transaction invocation interface.

Return value

MWspCOMethodInvoker& Interface to be used by the client for transaction invocations.

Panic codes

This function will panic if the service isn't supported by a particular implementation of the API.

virtual MWspCOPushInvoker& COPushInvoker()=0;

Description

Gets the connection-oriented push invocation interface.

Return value

MWspCOPushInvoker & Interface to be used by the client to signal readiness to receive CO push invocations.

Panic codes

This function will panic if the service isn't supported by a particular implementation of the API.

virtual MWspCLMethodInvoker& CLMethodInvoker()=0;

Description

Gets the connection-less method invocation interface.

Return value

MWspCLMethodInvoker & Interface to be used by the client for CL method invocations.

Panic codes

This function will panic if the service isn't supported by a particular implementation of the API.

virtual MWspCLPushInvoker& CLPushInvoker()=0;

Description

Gets the connection-less push invocation interface.

Return value

MWspCLPushInvoker& Interface to be used by the client to signal readiness to receive CL push invocations.

Panic codes

This function will panic if the service isn't supported by a particular implementation of the API.

protected: struct SInstantiationParams

Description

A structure containing the instantiation parameters to NewL(), passed by ECom to the sub-class NewL().

Defined in CWspTransportHandler::SInstantiationParams:
iCapProv, iProxyInfoProv, iSecurityPolicy, iSessHdrProv, iSessionCB, iStringPool

---

iStringPool

RStringPool* iStringPool;

Description

An open string pool reference.

---

iSecurityPolicy

MSecurityPolicy* iSecurityPolicy;

Description

The security policy plugin.

---

iSessionCB

MWspCOSessionCallback* iSessionCB;

Description

A client callback interface for CO session events.

---

iProxyInfoProv

MWspProxyInfoProvider* iProxyInfoProv;

Description

A client interface that provides WAP proxy details.

---

iCapProv

MWspCapabilityProvider* iCapProv;

Description

A client interface for capability negotatiation.

---

iSessHdrProv

MWspSessionHeadersProvider* iSessHdrProv;

Description

A client interface for exchange of session headers.

typedef TUint8 TWspSupportedServices;

Description

A bit-field type that is set to contain a union of the services supported by the WSP transport handler.

TWspService

Description

Defines flags for the five different service types that can be supported.

ECOSessionService Connection-Oriented Session service. ECOMethodInvocationService Connection-Oriented Transaction service. ECOPushService Connection-Oriented Push service. ECLSessionService Connection-Less Session service. ECLPushService Connection-Less Push service.

protected: RStringPool iStringPool;

Description

Handle for a string pool used by the WSP transport handler. This is owned and managed elsewhere.

protected: MSecurityPolicy* iSecurityPolicy;

Description

An optional security policy plug-in.

If a plug-in was not supplied, the value is NULL.

protected: MWspCOSessionCallback& iSessionCB;

Description

The client's callback for session events.

protected: MWspProxyInfoProvider& iProxyInfoProv;

Description

The client's provider of proxy information.

protected: MWspCapabilityProvider& iCapProv;

Description

The client's provider of capabilities information.

protected: MWspSessionHeadersProvider& iSessHdrProv;

Description

The client's provider of session headers.

private: TUid iDtor_ID_Key;

Description

This is internal and not intended for use.