CWapBoundDatagramService Class Reference

#include <wapmessage.h>

Link against: wapmsgcli.lib

class CWapBoundDatagramService : public CBase

Inherits from

CWapBoundDatagramService
- CBase

Public Member Functions
virtual	~CWapBoundDatagramService()
pure virtual TInt	AwaitRecvDataSize(TPckg< TUint16 > &, TRequestStatus &)
pure virtual void	CancelRecv()
pure virtual TInt	Connect(Wap::TBearer, Wap::TPort, TInetAddr)
pure virtual TInt	Connect(Wap::TBearer, Wap::TPort)
pure virtual TInt	GetBearer(Wap::TBearer &)
pure virtual TInt	GetDatagramSizes(TUint16 &, TUint16 &)
pure virtual TInt	GetLocalAddress(HBufC8 *&)
pure virtual TInt	GetLocalPort(Wap::TPort &)
IMPORT_C CWapBoundDatagramService *	NewL()
IMPORT_C CWapBoundDatagramService *	NewL(const TUid &)
pure virtual TInt	RecvFrom(TDes8 &, Wap::TPort &, TDes8 &, TBool &, TRequestStatus &, TUint32)
pure virtual TInt	SendTo(const TDesC8 &, Wap::TPort, const TDesC8 &, Wap::TBearer)

Protected Member Functions
	CWapBoundDatagramService()
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

Bound WDP Sends and receives datagrams over WDP using a specified local port.

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

CWapBoundDatagramService ( )

IMPORT_C

CWapBoundDatagramService

(

)

[protected]

~CWapBoundDatagramService ( )

IMPORT_C

~CWapBoundDatagramService

(

)

[virtual]

Destructor

Member Function Documentation

AwaitRecvDataSize ( TPckg< TUint16 > &, TRequestStatus & )

TInt	AwaitRecvDataSize	(	TPckg< TUint16 > &	aDataSizePckg,
			TRequestStatus &	aReqStatus
		)	[pure virtual]

Waits for a datagram to be received, and discovers the size of buffer required to retrieve it.

This asynchronous method 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 RecvFrom() with a buffer of sufficient size will then allow the client to retrieve the datagram fully.

Parameters
aDataSizePckg	On completion, the size of data received, in bytes
aReqStatus	Asynchonrous status word, used to signal when a data size is known

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

CancelRecv ( )

void

CancelRecv

(

)

[pure virtual]

Cancels a previously asynchronous RecvFrom() or AwaitRecvDataSize() request.

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

Connect ( Wap::TBearer, Wap::TPort, TInetAddr )

TInt	Connect	(	Wap::TBearer	aBearer,
			Wap::TPort	aPort,
			TInetAddr	aInetAddr
		)	[pure virtual]

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

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 CWapBoundDatagramService implementations must automatically close this endpoint upon destruction.

Parameters
aBearer	The bearer to listen on. Use EAll to specify all bearers.
aPort	The port to listen on. If set to 0, a local port will be chosen for the client's first SendTo()
aInetAddr	The IP address of the network interface that should be used in a multihomed system.

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

Connect ( Wap::TBearer, Wap::TPort )

TInt	Connect	(	Wap::TBearer	aBearer,
			Wap::TPort	aPort
		)	[pure virtual]

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

All CWapBoundDatagramService implementations must automatically close this endpoint upon destruction.

Parameters
aBearer	The bearer to listen on. Use EAll to specify all bearers.
aPort	The port to listen on. If set to 0, a local port will be chosen for the client's first SendTo()

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

ConstructL ( )

IMPORT_C void

ConstructL

(

)

[protected]

GetBearer ( Wap::TBearer & )

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().

Parameters
aBearer	On return, the bearer

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

GetDatagramSizes ( TUint16 &, TUint16 & )

TInt	GetDatagramSizes	(	TUint16 &	aMaxSize,
			TUint16 &	aNominalSize
		)	[pure virtual]

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.

The function will fail for a stream connection.

Parameters
aMaxSize	On return, the maximum datagram size
aNominalSize	On return, the nominal datagram size

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

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 CWapBoundDatagramService *

NewL

(

)

[static]

Bound WDP Allocates and creates a new CWapBoundDatagramService object.

Return Value: A new CWapBoundDatagramService object.

Leave Codes
System	wide error codes

NewL ( const TUid & )

IMPORT_C CWapBoundDatagramService *

NewL

(

const TUid &

aImplementation

)

[static]

Allocates and creates a new CWapBoundDatagramService object.

Return Value: A new CWapBoundDatagramService object.

Leave Codes
System	wide error codes

RecvFrom ( TDes8 &, Wap::TPort &, TDes8 &, TBool &, TRequestStatus &, TUint32 )

TInt	RecvFrom	(	TDes8 &	aRemoteHost,
			Wap::TPort &	aRemotePort,
			TDes8 &	aBuffer,
			TBool &	aTruncated,
			TRequestStatus &	aReqStatus,
			TUint32	aTimeout
		)	[pure virtual]

Receives data on a bound port.

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

Parameters
aRemoteHost	On completion, the bearer-dependent address of the remote host from which the data was received
aRemotePort	On completion, the port on the remote host from which the data was received
aBuffer	A client-allocated data buffer that on completion is filled with data received. Data that overflows the buffer is discarded.
aTruncated	On completion, indicates whether the received datagram was truncated to fit in the client's supplied buffer
aReqStatus	Asynchronous status word, used to notify the client that a datagram was received
aTimeout	An optional millisecond time-out which allows a timed read to be made. If no data is received within the timeout period, the request completes with KErrTimedOut. If a value of 0 is supplied, the timeout is infinite.

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

SendTo ( const TDesC8 &, Wap::TPort, const TDesC8 &, Wap::TBearer )

TInt	SendTo	(	const TDesC8 &	aRemoteHost,
			Wap::TPort	aRemotePort,
			const TDesC8 &	aBuffer,
			Wap::TBearer	aBearer
		)	[pure virtual]

Sends data to a remote endpoint.

Parameters
aRemoteHost	The address of the remote host to which to send the data. The format of the address is bearer-specific.
aRemotePort	The port on the remote host to which the data will be sent
aBuffer	The data buffer to be sent
aBearer	The bearer to be used, if the bound connection was opened with EAll

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