RPbapSession Class Reference

class RPbapSession : public RSessionBase

Provides client side access to the PBAP server.

Inherits from

Public Member Functions
RPbapSession()
IMPORT_C TIntConnect()
IMPORT_C TIntSetPassword(const TDesC &)
IMPORT_C TIntStart()
IMPORT_C voidStop()
IMPORT_C TInt__DbgCheckHeap(TInt)
IMPORT_C TInt__DbgFailNext(TInt)
IMPORT_C TInt__DbgMarkEnd(TInt)
IMPORT_C TInt__DbgMarkHeap()
Private Member Functions
TVersion Version()
Inherited Functions
RHandleBase::Attributes()const
RHandleBase::BTraceId()const
RHandleBase::Close()
RHandleBase::DoExtendedClose()
RHandleBase::Duplicate(const RThread &,TOwnerType)
RHandleBase::FullName()const
RHandleBase::FullName(TDes &)const
RHandleBase::Handle()const
RHandleBase::HandleInfo(THandleInfo *)
RHandleBase::Name()const
RHandleBase::NotifyDestruction(TRequestStatus &)
RHandleBase::Open(const TFindHandleBase &,TOwnerType)
RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
RHandleBase::RHandleBase()
RHandleBase::RHandleBase(TInt)
RHandleBase::SetHandle(TInt)
RHandleBase::SetHandleNC(TInt)
RSessionBase::CreateSession(RServer2,const TVersion &)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy *,TRequestStatus *)
RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Open(TInt,TOwnerType)
RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
RSessionBase::Send(TInt)const
RSessionBase::Send(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt)const
RSessionBase::SendReceive(TInt,TRequestStatus &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSessionBase::SetReturnedHandle(TInt)
RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
RSessionBase::ShareAuto()
RSessionBase::ShareProtected()
Inherited Enumerations
RHandleBase:TAttributes
RSessionBase:TAttachMode
Private Attributes
TUint32 iPadding
Inherited Attributes
RHandleBase::iHandle

Constructor & Destructor Documentation

RPbapSession()

IMPORT_CRPbapSession()

Standard constructor.

Member Functions Documentation

Connect()

IMPORT_C TIntConnect()

Connects the client to the Bluetooth PBAP Server.

This must be used before any of the other methods listed in this API section. The first client to call this method will cause the initiation of the PBAP server within its own executable process. The PBAP Server will only allow at most one session to be connected at any one time and any subsequent attempts to Connect() to the server will result in KErrInUse being returned.

Once a connection to the server has completed successfully Start() must be called to allow PCE requests.

capability
None

SetPassword(const TDesC &)

IMPORT_C TIntSetPassword(const TDesC &aPassword)

Sets the password required to access the PBAP server, this can be done before or after a call to RPbapSession::Start. When a password is set, a PCE must specify it to access the server. To remove the need for the password, the PBAP server must be stopped and re-started.

capability
LocalServices
capability
ReadUserData

Parameters

const TDesC & aPassword

Start()

IMPORT_C TIntStart()

Start listening for PCE requests (via Obex over Bluetooth) in the PBAP server. If this request is successful sessions with a PCE can be established

capability
LocalServices
capability
ReadUserData

Stop()

IMPORT_C voidStop()

Stop listening for PCE requests to the PBAP server. Once this function is called all PCE requests will fail until the next successful Start() call. Calling this function during a request will result in an Obex disconnect being reported to the client.

capability
LocalServices
capability
ReadUserData

Version()

TVersion Version()const [private]

Get the PBAP server version.

__DbgCheckHeap(TInt)

IMPORT_C TInt__DbgCheckHeap(TIntaCount)

Performs a heap mark check in the PBAP Server thread.

capability
None

Parameters

TInt aCountThe number of heap cells expected to be allocated at the current nest level.

__DbgFailNext(TInt)

IMPORT_C TInt__DbgFailNext(TIntaCount)

Set a heap fail next condition in the PBAP server thread.

capability
None

Parameters

TInt aCountDetermines when the allocation will fail.

__DbgMarkEnd(TInt)

IMPORT_C TInt__DbgMarkEnd(TIntaCount)

Perfom a heap mark end check in the PBAP server thread.

capability
None

Parameters

TInt aCountThe number of heap cells expected to remain allocated at the current nest level.

__DbgMarkHeap()

IMPORT_C TInt__DbgMarkHeap()

Set a heap mark in the PBAP server thread.

capability
None

Member Data Documentation

TUint32 iPadding

TUint32 iPadding[private]