Collapse all Symbian^3 Application Developer Library

conn::CSBJavaId Class Reference

class conn::CSBJavaId : public conn::CSBGenericDataType

Generic Data Type representing a MIDlet data owner identified by a Suite Name, Vendor Name, Version and a unique MIDlet Suite Hash. The Suite Hash should be used as the unique identifier for the MIDlet suite.

Byte Structure

All child classes have their data following on from the parent classes so that the parent classes may remain atomic with respect to the structure of their data. The binary structure of this data type inside the descriptor buffer is as follows. Note that the endianness of the data types specified below is determined by the platform and the PC must pack accordingly:

TSBDerivedType [4-bytes]

MIDlet suite name length [4-bytes]

MIDlet suite name [2*length]

MIDlet suite vendor length [4-bytes]

MIDlet suite vendor [2*length]

MIDlet suite version length [4-bytes]

MIDlet suite version [2*length]

MIDlet suite hash length [4-bytes] (should be 32)

MIDlet suite hash [2*length]

Byte Structure

TSBDerivedType [4-bytes]

MIDlet suite name length [4-bytes]

MIDlet suite name [2*length]

MIDlet suite vendor length [4-bytes]

MIDlet suite vendor [2*length]

MIDlet suite version length [4-bytes]

MIDlet suite version [2*length]

MIDlet suite hash length [4-bytes] (should be 32)

MIDlet suite hash [2*length]

Inherits from

conn::CSBJavaId
- conn::CSBGenericDataType
  - CBase

Public Member Functions
	~CSBJavaId ()
IMPORT_C CSBJavaId *	NewL (const TDesC &, const TDesC &, const TDesC &, const TDesC &)
IMPORT_C const TDesC &	SuiteHashL ()
IMPORT_C const TDesC &	SuiteVendorL ()
IMPORT_C const TDesC &	SuiteVersionL ()

Protected Member Functions
void	InitialiseL ( TInt &)
void	InitialiseL ( TInt &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)

Private Member Functions
	CSBJavaId ()
	CSBJavaId (const TDesC &, const TDesC &, const TDesC &, const TDesC &)
void	ConstructFromExistingL ( CSBGenericDataType *)
void	ConstructL (const TDesC &, const TDesC &, const TDesC &, const TDesC &)

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()
	conn::CSBGenericDataType::BaseConstructL()
	conn::CSBGenericDataType::CSBGenericDataType()
	conn::CSBGenericDataType::ConstructL(const TDesC8 &)
	conn::CSBGenericDataType::DerivedTypeL()const
	conn::CSBGenericDataType::Externalise()const
	conn::CSBGenericDataType::NewL(const TDesC8 &)
	conn::CSBGenericDataType::PackDescriptorTypeAdvance(const TDesC16 &,TInt &)
	conn::CSBGenericDataType::PackDescriptorTypeAdvance(const TDesC8 &,TInt &)
	conn::CSBGenericDataType::UnpackDescriptorTypeAdvance(TDesC16 &,TInt &)
	conn::CSBGenericDataType::UnpackDescriptorTypeAdvance(TDesC8 &,TInt &)
	conn::CSBGenericDataType::UnpackTPtrAdvance(TPtrC16 &,TInt &)
	conn::CSBGenericDataType::UnpackTPtrAdvance(TPtrC8 &,TInt &)
	conn::CSBGenericDataType::~CSBGenericDataType()

Private Attributes
TPtrC	iSuiteHash
TPtrC	iSuiteName
TPtrC	iSuiteVendor
TPtrC	iSuiteVersion

Inherited Attributes
	conn::CSBGenericDataType::iDataBuffer
	conn::CSBGenericDataType::iDerivedTypeOffset
	conn::CSBGenericDataType::iSize

Constructor & Destructor Documentation

CSBJavaId()

CSBJavaId

(

)

[private]

CSBJavaId(const TDesC &, const TDesC &, const TDesC &, const TDesC &)

CSBJavaId	(	const TDesC &	aSuiteName,
		const TDesC &	aSuiteVendor,
		const TDesC &	aSuiteVersion,
		const TDesC &	aSuiteHash
	)	[private]

C++ Constructor. Any derived types must increment iSize in their C++ constructors in order that when CSBGenericDataType::BaseConstructL() is called, the data buffer is initialised to be large enough to accomodate the data stored by the derived type

Parameters

const TDesC & aSuiteName	The name of the MIDlet suite
const TDesC & aSuiteVendor	The name of the vendor of the MIDlet suiet
const TDesC & aSuiteVersion	The version of the MIDlet suite
const TDesC & aSuiteHash	The Java MIDlet suite hash

~CSBJavaId()

IMPORT_C

~CSBJavaId

(

)

C++ Destructor

Member Functions Documentation

ConstructFromExistingL(CSBGenericDataType *)

void

ConstructFromExistingL

(

CSBGenericDataType *

aGenericDataType

)

[private]

Parameters

CSBGenericDataType * aGenericDataType

ConstructL(const TDesC &, const TDesC &, const TDesC &, const TDesC &)

void	ConstructL	(	const TDesC &	aSuiteName,
			const TDesC &	aSuiteVendor,
			const TDesC &	aSuiteVersion,
			const TDesC &	aSuiteHash
		)	[private]

Symbian OS 2nd phase constructor.

Parameters

const TDesC & aSuiteName	The name of the MIDlet suite
const TDesC & aSuiteVendor	The name of the vendor of the MIDlet suiet
const TDesC & aSuiteVersion	The version of the MIDlet suite
const TDesC & aSuiteHash	The Java MIDlet suite hash

InitialiseL(TInt &)

void

InitialiseL

(

TInt &

aOffset

)

[protected, virtual]

Initialise all member pointers to data

Parameters

TInt & aOffset

The running offset of where the descriptor has been parsed up to

InitialiseL(TInt &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)

void	InitialiseL	(	TInt &	aOffset,
			const TDesC &	aSuiteName,
			const TDesC &	aSuiteVendor,
			const TDesC &	aSuiteVersion,
			const TDesC &	aSuiteHash
		)	[protected]

Parameters

TInt & aOffset
const TDesC & aSuiteName
const TDesC & aSuiteVendor
const TDesC & aSuiteVersion
const TDesC & aSuiteHash

NewL(const TDesC &, const TDesC &, const TDesC &, const TDesC &)

IMPORT_C CSBJavaId *	NewL	(	const TDesC &	aSuiteName,
			const TDesC &	aSuiteVendor,
			const TDesC &	aSuiteVersion,
			const TDesC &	aSuiteHash
		)	[static]

Symbian constructor used for creating a derived class from it's constituent parameters. Used for example when creating a derived type from scratch

Parameters

const TDesC & aSuiteName	the name of the java suite
const TDesC & aSuiteVendor	the suite vendor
const TDesC & aSuiteVersion	the version of the java suite
const TDesC & aSuiteHash	the hash of the java suite

SuiteHashL()

IMPORT_C const TDesC &

SuiteHashL

(

)

const

SuiteVendorL()

IMPORT_C const TDesC &

SuiteVendorL

(

)

const

Getter for the MIDlet suite vendor

SuiteVersionL()

IMPORT_C const TDesC &

SuiteVersionL

(

)

const

Getter for the MIDlet suite version

Member Data Documentation

TPtrC iSuiteHash

TPtrC

iSuiteHash

[private]

The MIDlet suite Hash

TPtrC iSuiteName

TPtrC

iSuiteName

[private]

The MIDlet suite Name

TPtrC iSuiteVendor

TPtrC

iSuiteVendor

[private]

The MIDlet suite Vendor

TPtrC iSuiteVersion

TPtrC

iSuiteVersion

[private]

The MIDlet suite Version