CWapFullySpecCLPushService Class Reference

#include <wapmessage.h>

Link against: wapmsgcli.lib

class CWapFullySpecCLPushService : public CBase

Inherits from

CWapFullySpecCLPushService
- CBase

Public Member Functions
virtual	~CWapFullySpecCLPushService()
pure virtual TInt	AwaitPush(TDes8 &, TDes8 &, TPckgBuf< TUint8 > &, TRequestStatus &)
pure virtual void	CancelAwaitPush()
pure virtual TInt	Connect(const TDesC8 &, Wap::TPort, Wap::TBearer, TBool, TInetAddr)
pure virtual TInt	Connect(const TDesC8 &, Wap::TPort, Wap::TBearer, TBool)
pure virtual TInt	GetLocalAddress(HBufC8 *&)
pure virtual TInt	GetLocalPort(Wap::TPort &)
IMPORT_C CWapFullySpecCLPushService *	NewL()
IMPORT_C CWapFullySpecCLPushService *	NewL(const TUid &)

Protected Member Functions
	CWapFullySpecCLPushService()
IMPORT_C void	ConstructL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

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.

Constructor & Destructor Documentation

CWapFullySpecCLPushService ( )

IMPORT_C

CWapFullySpecCLPushService

(

)

[protected]

~CWapFullySpecCLPushService ( )

IMPORT_C

~CWapFullySpecCLPushService

(

)

[virtual]

Destructor

Member Function 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
aPushHeaders	A client-allocated buffer that, on completion, is filled with the push message's header data
aPushBody	A client-allocated buffer that, on completion, is filled with the push message's body data
aPushIdPckg	On completion, an integer ID that uniquely specifies the push message
aReqStatus	Asynchronous 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.

Return Value: KErrNone on successful completion, or one of the system error codes on failure.

CancelAwaitPush ( )

void

CancelAwaitPush

(

)

[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::TPort	aRemotePort,
			Wap::TBearer	aBearer,
			TBool	aSecure,
			TInetAddr	aInetAddr
		)	[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
aRemoteHost	The bearer-dependent address of the remote host with which the data will be exchanged
aRemotePort	The port on the remote host to which data will be sent
aBearer	The bearer to listen on. You cannot use EAll.
aSecure	Security flag to indicate whether WTLS should be used or not
aInetAddr	The address of the adapter to use

Return Value: KErrNone on successful completion, or one of the system error codes on failure.

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

TInt	Connect	(	const TDesC8 &	aRemoteHost,
			Wap::TPort	aRemotePort,
			Wap::TBearer	aBearer,
			TBool	aSecure
		)	[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
aRemoteHost	The bearer-dependent address of the remote host with which the data will be exchanged
aRemotePort	The port on the remote host to which data will be sent
aBearer	The bearer to listen on. You cannot use EAll.
aSecure	Security flag to indicate whether WTLS should be used or not

Return Value: KErrNone on successful completion, or one of the system error codes on failure.

ConstructL ( )

IMPORT_C void

ConstructL

(

)

[protected]

GetLocalAddress ( HBufC8 *& )

TInt

GetLocalAddress

(

HBufC8 *&

aLocalHost

)

[pure virtual]

Gets the local address of this endpoint.

Parameters
aLocalHost	On 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.

Return Value: KErrNone on successful completion, or one of the system error codes on failure.

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
aPort	On return, the port number

Return Value: KErrNone on successful completion, or one of the system error codes on failure.

NewL ( )

IMPORT_C CWapFullySpecCLPushService *

NewL

(

)

[static]

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

Return Value: A new CWapFullySpecCLPushService object.

Leave Codes
System	wide error codes.

NewL ( const TUid & )

IMPORT_C CWapFullySpecCLPushService *

NewL

(

const TUid &

aImplementation

)

[static]

Allocates and creates a new CWapFullySpecCLPushService object.

Return Value: A new CWapFullySpecCLPushService object.

Leave Codes
System	wide error codes.