Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: wapmessage.h
Link against: wapmsgcli.lib

Class CWapFullySpecCLWSPService

class CWapFullySpecCLWSPService : public CBase;

Description

Fully-Specified Connectionless WSP

Derivation

Members

Defined in CWapFullySpecCLWSPService:
CWapFullySpecCLWSPService(), CancelReq(), Connect(), ConstructL(), GetLocalAddress(), GetLocalPort(), MethodInvoke(), MethodResult(), NewL(), NewL(), ~CWapFullySpecCLWSPService()

Inherited from CBase:
Delete(), Extension_(), operator new()


Construction and destruction


NewL()

static IMPORT_C CWapFullySpecCLWSPService *NewL();

Description

Allocates and creates a new CWapFullySpecCLWSPService object.

Return value

CWapFullySpecCLWSPService *

A new CWapFullySpecCLWSPService object.

Leave codes

System

wide error codes.


NewL()

static IMPORT_C CWapFullySpecCLWSPService *NewL(const TUid &aImplementation);

Description

Allocates and creates a new CWapFullySpecCLWSPService object.

Parameters

const TUid &aImplementation

Return value

CWapFullySpecCLWSPService *

A new CWapFullySpecCLWSPService object.

Leave codes

System

wide error codes.


~CWapFullySpecCLWSPService()

virtual IMPORT_C ~CWapFullySpecCLWSPService();

Description

Destructor


CWapFullySpecCLWSPService()

protected: IMPORT_C CWapFullySpecCLWSPService();

Description


ConstructL()

protected: IMPORT_C void ConstructL();

Description

[Top]


Member functions


Connect()

virtual TInt Connect(const TDesC8 &aRemoteHost, Wap::TPort aRemotePort, Wap::TBearer aBearer, TBool aSecure)=0;

Description

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

All CWapFullySpecCLWSPService implementations must automatically close this endpoint upon destruction.

Parameters

const TDesC8 &aRemoteHost

The bearer-dependent address of the remote host with which the data will be exchanged

Wap::TPort aRemotePort

The port on the remote host to which data will be sent

Wap::TBearer aBearer

The bearer to listen on. You cannot use EAll.

TBool aSecure

Security flag to indicate whether WTLS should be used or not

Return value

TInt

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


MethodInvoke()

virtual TInt MethodInvoke(TUint aMethod, const TDesC &aURI, const TDesC8 &aReqHeaders, const TDesC8 &aReqBody, TUint8 aTransactionId)=0;

Description

Sends a request to a remote endpoint.

Parameters

TUint aMethod

const TDesC &aURI

const TDesC8 &aReqHeaders

const TDesC8 &aReqBody

TUint8 aTransactionId

Return value

TInt

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


MethodResult()

virtual TInt MethodResult(TDes8 &aReqHeaders, TDes8 &aReqBody, TPckgBuf< TUint8 > &aTransactionIdPckg, TWSPStatus &aWspStatus, TRequestStatus &aReqStatus, TUint32 aTimeout)=0;

Description

Waits for a datagram to be received

Parameters

TDes8 &aReqHeaders

TDes8 &aReqBody

TPckgBuf< TUint8 > &aTransactionIdPckg

TWSPStatus &aWspStatus

TRequestStatus &aReqStatus

Asynchonrous status word, used to signal when a data size is known

TUint32 aTimeout

Return value

TInt

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


CancelReq()

virtual void CancelReq()=0;

Description

Cancels a previously-requested MethodResult() notification.

If a message arrives the client will not be notified.


GetLocalPort()

virtual TInt GetLocalPort(Wap::TPort &aPort)=0;

Description

Gets the local port of this endpoint.

This is useful if the port was chosen automatically.

Parameters

Wap::TPort &aPort

On return, the port number

Return value

TInt

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


GetLocalAddress()

virtual TInt GetLocalAddress(HBufC8 *&aLocalHost)=0;

Description

Gets the local address of this endpoint.

Parameters

HBufC8 *&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

TInt

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