TLbsNetSessionId Class Reference

class TLbsNetSessionId : public TLbsNetClassTypeBase

Session Identifiers are used to uniquely identify requests either generated by, or received by, a network protocol module.

TLbsNetSessionId contains two fields - an owner and a request number. The owner is the UID of the component that created the request. The request number is used to uniquely identify a request by that component.

The request number may increment with each new request. However, this is not guaranteed. In some instances, the request number will be derived from details obtained by the network.

For requests generated by the network protocol module, the ECom implementation UID should be used as the session id owner. Where, requests originate from within the LBS subsystem, the owner will be the UID of the component that created the request. This will normally be the Network Request Handler.

MLbsNetworkProtocolObserver CLbsNetworkProtocolBase

Inherits from

Constructor & Destructor Documentation

TLbsNetSessionId()

IMPORT_C TLbsNetSessionId ( )

Default constructor for TLbsNetSessionId

Sets the session owner to TUid::Null() and the session request number to 0

TLbsNetSessionId(TUid, TSessionNum)

IMPORT_C TLbsNetSessionId ( TUid aSessionOwner,
TSessionNum aSessionNum
)

Constructor for TLbsNetSessionId

Parameters

TUid aSessionOwner The session owner
TSessionNum aSessionNum The request number

Member Functions Documentation

IncrSession()

IMPORT_C void IncrSession ( )

Increments the request number

SessionNum()

IMPORT_C TSessionNum SessionNum ( ) const

Get the request number

SessionOwner()

IMPORT_C TUid SessionOwner ( ) const

Get the owner of the session

SetSessionNum(TSessionNum)

IMPORT_C void SetSessionNum ( TSessionNum aSessionNum )

Set the request number

Parameters

TSessionNum aSessionNum The request number

SetSessionOwner(TUid)

IMPORT_C void SetSessionOwner ( TUid aSessionOwner )

Set the session owner

Parameters

TUid aSessionOwner The session owner

operator!=(const TLbsNetSessionId &)

IMPORT_C TBool operator!= ( const TLbsNetSessionId & aSessionId ) const

Tests if two session Ids are not equal

Parameters

const TLbsNetSessionId & aSessionId

operator==(const TLbsNetSessionId &)

IMPORT_C TBool operator== ( const TLbsNetSessionId & aSessionId ) const

Tests if two session Ids are equal

Parameters

const TLbsNetSessionId & aSessionId

Member Type Definitions Documentation

Typedef TSessionNum

typedef TUint32 TSessionNum

Member Data Documentation

TUint8 iReserved

TUint8 iReserved [protected]

TUint32 iSessionNum

TUint32 iSessionNum [protected]

TUid iSessionOwner

TUid iSessionOwner [protected]