| class CWapBoundCLPushService : public CBase |
Bound Connectionless Push Listens for WAP Push messages from any sender.
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.
| Public Member Functions | |
|---|---|
| ~CWapBoundCLPushService() | |
| TInt | AwaitPush(TDes8 &, TDes8 &, TPckgBuf< TUint8 > &, TRequestStatus &) |
| void | CancelAwaitPush() |
| TInt | Connect(Wap::TBearer, Wap::TPort, TBool, TInetAddr) |
| TInt | Connect(Wap::TBearer, Wap::TPort, TBool) |
| TInt | GetBearer(Wap::TBearer &) |
| TInt | GetLocalAddress(HBufC8 *&) |
| TInt | GetLocalPort(Wap::TPort &) |
| TInt | GetServerAddress(HBufC8 *&) |
| IMPORT_C CWapBoundCLPushService * | NewL() |
| IMPORT_C CWapBoundCLPushService * | NewL(const TUid &) |
| Protected Member Functions | |
|---|---|
| CWapBoundCLPushService() | |
| IMPORT_C void | ConstructL() |
| Private Attributes | |
|---|---|
| TUid | iDtor_ID_Key |
| 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.
| TDes8 & aPushHeaders | A client-allocated buffer that, on completion, is filled with the push message's header data |
| TDes8 & aPushBody | A client-allocated buffer that, on completion, is filled with the push message's body data |
| TPckgBuf< TUint8 > & aPushIdPckg | On completion, an integer ID that uniquely specifies the push message |
| TRequestStatus & aReqStatus | Asynchonrous 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. |
| void | CancelAwaitPush | ( | ) | [pure virtual] |
Cancels a previous push message request.
If a push message arrives, the client will not be notified.
| TInt | Connect | ( | Wap::TBearer | aBearer, |
| Wap::TPort | aPort, | |||
| TBool | aSecure, | |||
| TInetAddr | aInetAddr | |||
| ) | [pure virtual] | |||
Connects to the WAP stack, opening an endpoint that can be used to listen for Push messages from any sender.
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 CWapBoundCLPushService implementations must automatically close this endpoint upon destruction.
| Wap::TBearer aBearer | The bearer to listen on. Use EAll to specify all bearers. |
| Wap::TPort aPort | The port to listen on. If set to 0, a local port will be chosen for the client's first SendTo() |
| TBool aSecure | Security flag to indicate whether WTLS should be used or not |
| TInetAddr aInetAddr | The address of the adapter to use |
| TInt | Connect | ( | Wap::TBearer | aBearer, |
| Wap::TPort | aPort, | |||
| TBool | aSecure | |||
| ) | [pure virtual] | |||
Connects to the WAP stack, opening an endpoint that can be used to listen for Push messages from any sender.
All CWapBoundCLPushService implementations must automatically close this endpoint upon destruction.
| Wap::TBearer aBearer | The bearer to listen on. Use EAll to specify all bearers. |
| Wap::TPort aPort | The port to listen on. If set to 0, a local port will be chosen for the client's first SendTo() |
| TBool aSecure | Security flag to indicate whether WTLS should be used or not |
| TInt | GetBearer | ( | Wap::TBearer & | aBearer | ) | [pure virtual] |
Gets the bearer on which a received datagram arrived.
This is useful when EAll was specified as the bearer in Connect().
| Wap::TBearer & aBearer | On return, the bearer |
| TInt | GetLocalAddress | ( | HBufC8 *& | aLocalHost | ) | [pure virtual] |
Gets the local address of this endpoint.
| 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. |
| TInt | GetLocalPort | ( | Wap::TPort & | aPort | ) | [pure virtual] |
Gets the local port of this endpoint.
This is useful if the port was chosen automatically.
| Wap::TPort & aPort | On return, the port number |
| TInt | GetServerAddress | ( | HBufC8 *& | aRemoteHost | ) | [pure virtual] |
Gets the address of the remote server.
This function cannot be called when there is an outstanding AwaitPush().
| HBufC8 *& aRemoteHost | On return, the address of the remote 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. |
| IMPORT_C CWapBoundCLPushService * | NewL | ( | ) | [static] |
Bound Connection-less Push Allocates and creates a new CWapBoundCLPushService object.
| IMPORT_C CWapBoundCLPushService * | NewL | ( | const TUid & | aImplementation | ) | [static] |
Allocates and creates a new CWapBoundCLPushService object.
| const TUid & aImplementation |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.