MObexHeaderCheck Class Reference

#include <mw/obexheaders.h>

Link against: obex.lib

class MObexHeaderCheck
Public Member Functions
pure virtual IMPORT_C TBoolInterested(TUint8)
virtual IMPORT_C voidMOHC_ExtensionInterfaceL(TUid, void *&)
virtual IMPORT_C voidReset()

Detailed Description

Used to allow the iterator to decide whether to present a header to the user, by passing in a possible header HI value. Headers present in the object will be presented to the Interested() function in the object in which they are held (if received from a remote device this will be the order in which they were received, otherwise this will be the order in which they were set). The function can implement any desired behaviour, including relying on the order in which the headers are presented.

In case any state is held, the object also provides a Reset() function. Reset() provides a default empty implementation.

Note: there is no destructor.

Member Function Documentation

Interested ( TUint8 )

IMPORT_C TBoolInterested(TUint8aHI)[pure virtual]

Called to discover is the user is interested in the contents of this header.

ParameterDescription
aHIThe identifier of the header, including type bits.

Returns: ETrue if the user is interested in the contents of this header.

MOHC_ExtensionInterfaceL ( TUid, void *& )

IMPORT_C voidMOHC_ExtensionInterfaceL(TUidaInterface,
void *&aObject
)[virtual]

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.

ParameterDescription
aInterfaceUID of the interface to return
aObjectthe container for another interface as specified by aInterface

Reset ( )

IMPORT_C voidReset()[virtual]

Called in response to First() being called on the iterator object. The default implementation does nothing---some implementations may wish to reset state variables.