Class CWapFullySpecDatagramService

class CWapFullySpecDatagramService : public CBase;

Description

Sends and receives datagrams over WDP using a specified local port and a single, named remote host.

The class is an ECom plug-in interface. Clients use CWapFullySpecDatagramService::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.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CWapFullySpecDatagramService - Sends and receives datagrams over WDP using a specified local port and a single,...

Members

Defined in CWapFullySpecDatagramService:

• AwaitRecvDataSize(TPckg< TUint16 > &,TRequestStatus &)Waits for a datagram to be received, and discover how large a buffer is required...
• CWapFullySpecDatagramService()
• CancelRecv()Cancels a previously asynchronous CWapFullySpecDatagramService::Recv(TDes8 &...
• ConstructL()
• GetDatagramSizes(TUint16 &,TUint16 &)Queries the WDP bearer for its maximum datagram size and its nominal datagram si...
• GetLocalAddress(HBufC8 *&)Gets the local address of this endpoint.
• NewL()Allocates and creates a new CWapFullySpecDatagramService object.
• NewL(const TUid &)Allocates and creates a new CWapFullySpecDatagramService object.
• Recv(TDes8 &,TBool &,TRequestStatus &,TUint32)Receives data on a bound port.
• Send(const TDesC8 &)Sends data on a fully-specified connection.
• ~CWapFullySpecDatagramService()Destructor

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CWapFullySpecDatagramService* NewL();

Description

Allocates and creates a new CWapFullySpecDatagramService object.

Return value

Leave codes

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

Description

Allocates and creates a new CWapFullySpecDatagramService object.

Parameters

Return value

Leave codes

IMPORT_C virtual ~CWapFullySpecDatagramService();

Description

Destructor

protected: IMPORT_C CWapFullySpecDatagramService();

Description

protected: IMPORT_C void ConstructL();

Description

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

Description

Connects to the WAP stack, opening an endpoint that can be used to listen for subsequent incoming datagrams.

This overload of CWapFullySpecDatagramService::Connect(const TDesC8 &,Wap::TPort,Wap::TBearer,TInetAddr) 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 CWapFullySpecDatagramService implementations must automatically close this endpoint upon destruction.

Parameters

Return value

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

Description

Connects to the WAP stack, opening an endpoint that can be used to listen for subsequent incoming datagrams.

All CWapFullySpecDatagramService implementations must automatically close this endpoint upon destruction.

Parameters

Return value

virtual TInt Send(const TDesC8 &aBuffer)=0;

Description

Sends data on a fully-specified connection.

Parameters

Return value

virtual TInt AwaitRecvDataSize(TPckg< TUint16 > &aDataSizePckg, TRequestStatus &aReqStatus)=0;

Description

Waits for a datagram to be received, and discover how large a buffer is required to retrieve it.

This asynchronous request waits for a datagram to be received and will then complete allowing the client to discover how large a buffer is needed to retrieve the entire datagram that has been received. A later call to CWapFullySpecDatagramService::Recv(TDes8 &,TBool &,TRequestStatus &,TUint32) with a buffer of sufficent size will then allow the client to retrieve the datagram fully.

Parameters

Return value

virtual TInt Recv(TDes8 &aBuffer, TBool &aTruncated, TRequestStatus &aReqStatus, TUint32 aTimeout)=0;

Description

Receives data on a bound port.

An asynchronous notification is sent to the client when data arrives.

Parameters

Return value

virtual void CancelRecv()=0;

Description

Cancels a previously asynchronous CWapFullySpecDatagramService::Recv(TDes8 &,TBool &,TRequestStatus &,TUint32) or CWapFullySpecDatagramService::AwaitRecvDataSize(TPckg< TUint16 > &,TRequestStatus &) request.

If a datagram arrives at the local host, it will be discarded.

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

Return value

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

Description

Gets the local address of this endpoint.

Parameters

Return value

virtual TInt GetDatagramSizes(TUint16 &aMaxSize, TUint16 &aNominalSize)=0;

Description

Queries the WDP bearer for its maximum datagram size and its nominal datagram size.

The nominal size is the size within which a datagram won't have to be split into smaller individual messages and then re-assembled at the other end.

Parameters

Return value