Class RBTCommPortSettings

class RBTCommPortSettings : public RBTManSubSession;

Description

A subsession on the Bluetooth Registry server This subsession allows the virtual serial ports to be updated, modified, examined etc.

Derivation

• RSubSessionBase - Client-side handle to a sub-session.

• RBTManSubSession - A subsession for the RBTMan session.

• RBTCommPortSettings - A subsession on the Bluetooth Registry server This subsession allows the virtual...

Members

Defined in RBTCommPortSettings:

• Close()Close the virtual serial port subsession on the Registry
• Delete(const TBTCommPortSettings &,TRequestStatus &)Delete virtual serial settings
• Get(TBTCommPortSettings &)Get the port settings for a given port At present the lookup is based on the por...
• Modify(const TBTCommPortSettings &,TRequestStatus &)Asynchronously update virtual serial port settings
• Open(RBTRegServ &)Open the virtual serial port subsession on the registry server
• RBTCommPortSettings()Default constructor

Inherited from RBTManSubSession:

• CancelRequest(TRequestStatus &)Cancel an outstanding request on btmanserver
• iClientServerMsg
• iPadding1
• iPadding2

Inherited from RSubSessionBase:

• CloseSubSession(TInt)Closes the sub-session.
• CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)Creates a new sub-session within an existing session. The new sub-session takes ...
• CreateSubSession(const RSessionBase &,TInt)Creates a new sub-session within an existing session.
• CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)Creates a new sub-session within an existing session.
• Send(TInt)constSends a blind message to the server - no reply is expected.
• Send(TInt,const TIpcArgs &)constSends a blind message to the server - no reply is expected.
• SendReceive(TInt)constSends a message to the server and waits synchronously for a reply.
• SendReceive(TInt,TRequestStatus &)constSends a message to the server and waits asynchronously for the reply.
• SendReceive(TInt,const TIpcArgs &)constSends a message to the server and waits synchronously for a reply.
• SendReceive(TInt,const TIpcArgs &,TRequestStatus &)constSends a message to the server and waits asynchronously for the reply.
• Session()constReturns a copy of the session associated with this sub-session.
• SubSessionHandle()constGets the sub-session handle number.

IMPORT_C RBTCommPortSettings();

Description

Default constructor

IMPORT_C TInt Open(RBTRegServ &aSession);

Description

Open the virtual serial port subsession on the registry server

Parameters

RBTRegServ &aSession the session on the Registry server on which to open this subsession

Return value

TInt Systemwide error code

IMPORT_C TInt Get(TBTCommPortSettings &aSettings);

Description

Get the port settings for a given port At present the lookup is based on the port number in aPortSettings

Synchronous

Parameters

TBTCommPortSettings &aSettings Reference to TBTCommPortSettings for result, and uses the port number within it to search

Return value

TInt System-wide error

IMPORT_C void Modify(const TBTCommPortSettings &aSettings, TRequestStatus &aStatus);

Description

Asynchronously update virtual serial port settings

Parameters

const TBTCommPortSettings &aSettings The new settings TRequestStatus &aStatus

IMPORT_C void Delete(const TBTCommPortSettings &aSettings, TRequestStatus &aStatus);

Description

Delete virtual serial settings

Parameters

const TBTCommPortSettings &aSettings reference to a const TBTCommPortSettings. aSettings MUST have a serial port number. This is used by the Registry to find the current settings and delete them from the Registry. TRequestStatus &aStatus reference to a TRequestStatus. Note this is an asynchronous call.

IMPORT_C virtual void Close();

Description

Close the virtual serial port subsession on the Registry