CWapFullySpecCLPushService Class Reference

class CWapFullySpecCLPushService : public CBase

Fully-Specified Connectionless Push Listens for WAP Push messages from a single, named remote host.

The class is an ECom plug-in interface. Clients use NewL() to request an implementation of the interface, and then call the interface's virtual functions to access the implementation's services.

The use of the plug-in architecture allows different implementations to use different underlying WAP stacks.

Functions can return system wide error codes, and also API-specific errors as defined in wapmsgerr.h.

Inherits from

  • CWapFullySpecCLPushService

Constructor & Destructor Documentation

CWapFullySpecCLPushService()

IMPORT_CCWapFullySpecCLPushService()[protected]

~CWapFullySpecCLPushService()

IMPORT_C~CWapFullySpecCLPushService()[virtual]

Destructor

Member Functions Documentation

AwaitPush(TDes8 &, TDes8 &, TPckgBuf< TUint8 > &, TRequestStatus &)

TInt AwaitPush(TDes8 &aPushHeaders,
TDes8 &aPushBody,
TPckgBuf< TUint8 > &aPushIdPckg,
TRequestStatus &aReqStatus
)[pure virtual]

Requests an asynchronous notification upon arrival of the next push message on the listening connection.

The request completes upon receipt of the message, filling the buffers with as much received data as possible. A return code indicates whether further data remains. The call must be re-issued for subsequent messages or to receive remaining data from a previous push message.

Parameters

TDes8 & aPushHeadersA client-allocated buffer that, on completion, is filled with the push message's header data
TDes8 & aPushBodyA client-allocated buffer that, on completion, is filled with the push message's body data
TPckgBuf< TUint8 > & aPushIdPckgOn completion, an integer ID that uniquely specifies the push message
TRequestStatus & aReqStatusAsynchronous status word, used by the service provider to notify the client when a push message has arrived. EMoreData is returned if more pushed data is available.

CancelAwaitPush()

voidCancelAwaitPush()[pure virtual]

Cancels a previous push message request.

If a push message arrives, the client will not be notified.

Connect(const TDesC8 &, Wap::TPort, Wap::TBearer, TBool, TInetAddr)

TInt Connect(const TDesC8 &aRemoteHost,
Wap::TPortaRemotePort,
Wap::TBeareraBearer,
TBoolaSecure,
TInetAddraInetAddr
)[pure virtual]

Connects to the WAP stack, opening an endpoint that can be used to listen for Push messages from a specified remote host.

This overload of Connect() allows an IP address associated with a network interface to be specified. In multihomed systems, this can be used to specify the network interface to which the endpoint should be bound.

All CWapFullySpecCLPushService implementations must automatically close this endpoint upon destruction.

Parameters

const TDesC8 & aRemoteHostThe bearer-dependent address of the remote host with which the data will be exchanged
Wap::TPort aRemotePortThe port on the remote host to which data will be sent
Wap::TBearer aBearerThe bearer to listen on. You cannot use EAll.
TBool aSecureSecurity flag to indicate whether WTLS should be used or not
TInetAddr aInetAddrThe address of the adapter to use

Connect(const TDesC8 &, Wap::TPort, Wap::TBearer, TBool)

TInt Connect(const TDesC8 &aRemoteHost,
Wap::TPortaRemotePort,
Wap::TBeareraBearer,
TBoolaSecure
)[pure virtual]

Connects to the WAP stack, opening an endpoint that can be used to listen for Push messages from a specified remote host.

All CWapFullySpecCLPushService implementations must automatically close this endpoint upon destruction.

Parameters

const TDesC8 & aRemoteHostThe bearer-dependent address of the remote host with which the data will be exchanged
Wap::TPort aRemotePortThe port on the remote host to which data will be sent
Wap::TBearer aBearerThe bearer to listen on. You cannot use EAll.
TBool aSecureSecurity flag to indicate whether WTLS should be used or not

ConstructL()

IMPORT_C voidConstructL()[protected]

GetLocalAddress(HBufC8 *&)

TInt GetLocalAddress(HBufC8 *&aLocalHost)[pure virtual]

Gets the local address of this endpoint.

Parameters

HBufC8 *& aLocalHostOn return, the address of the local host. Clients must pass in a reference to a NULL HBufC8 pointer. The function allocates a new HBufC8 buffer to hold the address, and passes ownership of the buffer to the client.

GetLocalPort(Wap::TPort &)

TInt GetLocalPort(Wap::TPort &aPort)[pure virtual]

Gets the local port of this endpoint.

This is useful if the port was chosen automatically.

Parameters

Wap::TPort & aPortOn return, the port number

NewL()

IMPORT_C CWapFullySpecCLPushService *NewL()[static]

Fully-specified Connection-less Push Allocates and creates a new CWapFullySpecCLPushService object.

leave
System wide error codes.

NewL(const TUid &)

IMPORT_C CWapFullySpecCLPushService *NewL(const TUid &aImplementation)[static]

Allocates and creates a new CWapFullySpecCLPushService object.

leave
System wide error codes.

Parameters

const TUid & aImplementation

Member Data Documentation

TUid iDtor_ID_Key

TUid iDtor_ID_Key[private]