Collapse all Symbian^3 Application Developer Library

MSdpElementBuilder Class Reference

class MSdpElementBuilder

Constructs an attribute value, or a set of attributes, from multiple data elements.

The builder interface is used for building single attribute values, and sets of attribute value, attribute ID pairs, as for example in a service record.

In particular, the builder interface can be implemented to receive the results from CSdpAgent attribute queries.

Each member function itself returns an MSdpElementBuilder interface that can then be used to add further elements.

For more on the format of attribute values, see [BS1 Service Discovery Protocol 3].

Note that the interface defines each function to leave with the error KErrGeneral.

CSdpAgent::AttributeRequestL()

Public Member Functions
IMPORT_C MSdpElementBuilder *	BuildBooleanL ( TBool )
IMPORT_C MSdpElementBuilder *	BuildDEAL ()
IMPORT_C MSdpElementBuilder *	BuildDESL ()
IMPORT_C MSdpElementBuilder *	BuildIntL (const TDesC8 &)
IMPORT_C MSdpElementBuilder *	BuildNilL ()
IMPORT_C MSdpElementBuilder *	BuildStringL (const TDesC8 &)
IMPORT_C MSdpElementBuilder *	BuildURLL (const TDesC8 &)
IMPORT_C MSdpElementBuilder *	BuildUUIDL (const TUUID &)
IMPORT_C MSdpElementBuilder *	BuildUintL (const TDesC8 &)
IMPORT_C MSdpElementBuilder *	BuildUnknownL ( TUint8 , TUint8 , const TDesC8 &)
IMPORT_C MSdpElementBuilder *	EndListL ()
IMPORT_C void	MSEB_ExtensionInterfaceL ( TUid , void *&)
IMPORT_C MSdpElementBuilder *	StartListL ()

Member Functions Documentation

BuildBooleanL(TBool)

IMPORT_C MSdpElementBuilder *

BuildBooleanL

(

TBool

aBool

)

[virtual]

Adds a Boolean element.

Parameters

TBool aBool

Element to add

BuildDEAL()

IMPORT_C MSdpElementBuilder *

BuildDEAL

(

)

[virtual]

Adds a (header for a) Data element alternative (DEA), a data element whose data field is a sequence of data elements from which one data element is to be selected.

This should be followed by a call to StartListL() , and then calls to add elements to the list.

BuildDESL()

IMPORT_C MSdpElementBuilder *

BuildDESL

(

)

[virtual]

Adds a (header for a) Data element sequence (DES), a data element whose data field is a sequence of data elements.

This should be followed by a call to StartListL() , and then calls to add elements to the list.

BuildIntL(const TDesC8 &)

IMPORT_C MSdpElementBuilder *

BuildIntL

(

const TDesC8 &

aInt

)

[virtual]

Adds a signed integer element.

Parameters

const TDesC8 & aInt

Element to add

BuildNilL()

IMPORT_C MSdpElementBuilder *

BuildNilL

(

)

[virtual]

Adds a null element.

BuildStringL(const TDesC8 &)

IMPORT_C MSdpElementBuilder *

BuildStringL

(

const TDesC8 &

aString

)

[virtual]

Adds a Text String element.

Parameters

const TDesC8 & aString

Element to add

BuildURLL(const TDesC8 &)

IMPORT_C MSdpElementBuilder *

BuildURLL

(

const TDesC8 &

aURL

)

[virtual]

Adds a URL element.

Parameters

const TDesC8 & aURL

Element to add

BuildUUIDL(const TUUID &)

IMPORT_C MSdpElementBuilder *

BuildUUIDL

(

const TUUID &

aUUID

)

[virtual]

Adds a UUID element.

Parameters

const TUUID & aUUID

Element to add

BuildUintL(const TDesC8 &)

IMPORT_C MSdpElementBuilder *

BuildUintL

(

const TDesC8 &

aUint

)

[virtual]

Adds an unsigned integer element.

Parameters

const TDesC8 & aUint

Element to add

BuildUnknownL(TUint8, TUint8, const TDesC8 &)

IMPORT_C MSdpElementBuilder *	BuildUnknownL	(	TUint8	aType,
			TUint8	aSizeDesc,
			const TDesC8 &	aData
		)	[virtual]

Adds an element of any type.

Parameters

TUint8 aType	Type descriptor
TUint8 aSizeDesc	Size descriptor
const TDesC8 & aData	Data field

EndListL()

IMPORT_C MSdpElementBuilder *

EndListL

(

)

[virtual]

Indicates that subsequent elements no longer belong to current DES or DEA

Building of current DES or DEA is terminated.

MSEB_ExtensionInterfaceL(TUid, void *&)

IMPORT_C void	MSEB_ExtensionInterfaceL	(	TUid	aInterface,
			void *&	aObject
		)

Returns a null aObject if the extension is not implemented, or a pointer to another interface if it is. This virtual function allows the M- classes to be extended in future in a binary compatible way by providing a method that clients can override in future to allow extra callbacks to be made via aObject.

Parameters

TUid aInterface	UID of the interface to return
void *& aObject	the container for another interface as specified by aInterface

StartListL()

IMPORT_C MSdpElementBuilder *

StartListL

(

)

[virtual]

Tell builder you are about to start a list

The end of the list should be indicated by a call to EndList().