Collapse all Symbian^3 Application Developer Library

CWapFullySpecDatagramService Class Reference

class CWapFullySpecDatagramService : public CBase

Fully-Specified WDP 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 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.

Inherits from

CWapFullySpecDatagramService
- CBase

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

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

Private Attributes
TUid	iDtor_ID_Key

Constructor & Destructor Documentation

CWapFullySpecDatagramService()

IMPORT_C

CWapFullySpecDatagramService

(

)

[protected]

~CWapFullySpecDatagramService()

IMPORT_C

~CWapFullySpecDatagramService

(

)

[virtual]

Destructor

Member Functions Documentation

AwaitRecvDataSize(TPckg< TUint16 > &, TRequestStatus &)

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

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 Recv() with a buffer of sufficent size will then allow the client to retrieve the datagram fully.

Parameters

TPckg < TUint16 > & aDataSizePckg	On completion, the size of data received, in bytes
TRequestStatus & aReqStatus	Asynchonrous status word, used to signal when a data size is known

CancelRecv()

void

CancelRecv

(

)

[pure virtual]

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

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

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

TInt	Connect	(	const TDesC8 &	aRemoteHost,
			Wap::TPort	aRemotePort,
			Wap::TBearer	aBearer,
			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 CWapFullySpecDatagramService 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 use. EAll cannot be used.
TInetAddr aInetAddr	The IP address of the network interface that should be used in a multihomed system.

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

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

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

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 use. EAll cannot be used.

ConstructL()

IMPORT_C void

ConstructL

(

)

[protected]

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.

Parameters

TUint16 & aMaxSize	On return, the maximum datagram size
TUint16 & aNominalSize	On return, the nominal datagram size

GetLocalAddress(HBufC8 *&)

TInt

GetLocalAddress

(

HBufC8 *&

aLocalHost

)

[pure virtual]

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.

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

Wap::TPort & aPort

On return, the port number

NewL()

IMPORT_C CWapFullySpecDatagramService *

NewL

(

)

[static]

Fully-specified WDP Allocates and creates a new CWapFullySpecDatagramService object.

leave: System wide error codes.

NewL(const TUid &)

IMPORT_C CWapFullySpecDatagramService *

NewL

(

const TUid &

aImplementation

)

[static]

Allocates and creates a new CWapFullySpecDatagramService object.

leave: System wide error codes.

Parameters

const TUid & aImplementation

Recv(TDes8 &, TBool &, TRequestStatus &, TUint32)

TInt	Recv	(	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

TDes8 & aBuffer	A client-allocated data buffer that, on completion, is filled with data received. Data that overflows the buffer is discarded.
TBool & aTruncated	On completion, indicates whether the received datagram was truncated to fit in the client's supplied buffer
TRequestStatus & aReqStatus	Asynchronous status word, used to notify the client that a datagram was received
TUint32 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.

Send(const TDesC8 &)

TInt

Send

(

const TDesC8 &

aBuffer

)

[pure virtual]

Sends data on a fully-specified connection.

Parameters

const TDesC8 & aBuffer

The data buffer to be written over the connection

Member Data Documentation

TUid iDtor_ID_Key

TUid

iDtor_ID_Key

[private]