Class TRfcommRemotePortParams

class TRfcommRemotePortParams;

Description

RF COMM remote port parameters.

Members

Defined in TRfcommRemotePortParams:
GetBitRate(), GetDataBits(), GetFlowCtrl(), GetParity(), GetStopBit(), GetXOffChar(), GetXOnChar(), IsValid(), SetBitRate(), SetDataBits(), SetFlowCtrl(), SetParity(), SetStopBit(), SetXOffChar(), SetXOnChar(), TRfcommRemotePortParams(), UpdateFlowCtrlBit(), UpdateFromRPNTransaction(), UpdateWholeFlowCtrl()

IMPORT_C TRfcommRemotePortParams();

Description

IMPORT_C TUint8 IsValid() const;

Description

Return value

TUint8

IMPORT_C TBool GetBitRate(TBps &aBitRate) const;

Description

Parameters

TBps &aBitRate

Return value

TBool

IMPORT_C TInt SetBitRate(TBps aBitRate);

Description

Parameters

TBps aBitRate

Return value

TInt

IMPORT_C TBool GetDataBits(TDataBits &aDataBits) const;

Description

If Data Bits are valid, sets reference and returns True, otherwise, returns False

Parameters

TDataBits &aDataBits

Return value

TBool

IMPORT_C TInt SetDataBits(TDataBits aDataBits);

Description

Parameters

TDataBits aDataBits

Return value

TInt

IMPORT_C TBool GetStopBit(TStopBits &aStopBit) const;

Description

If Stop Bit is valid, sets reference and returns True, otherwise, returns False

Parameters

TStopBits &aStopBit

Return value

TBool

IMPORT_C TInt SetStopBit(TStopBits aStopBit);

Description

Parameters

TStopBits aStopBit

Return value

TInt

IMPORT_C TBool GetParity(TParity &aParity) const;

Description

If Parity is valid, sets reference and returns True, otherwise, returns False

Parameters

TParity &aParity

Return value

TBool

IMPORT_C TInt SetParity(TParity aParity);

Description

Parameters

TParity aParity

Return value

TInt

IMPORT_C TBool GetFlowCtrl(TUint8 &aFlowCtrl) const;

Description

If Flow Control is valid, sets reference and returns True, otherwise, returns False

Parameters

TUint8 &aFlowCtrl

Return value

TBool

IMPORT_C TInt SetFlowCtrl(TUint8 aFlowCtrl);

Description

Parameters

TUint8 aFlowCtrl

Return value

TInt

IMPORT_C TBool GetXOnChar(TUint8 &aXOnChar) const;

Description

If XOn Char is valid, sets reference and returns True, otherwise, returns False

Parameters

TUint8 &aXOnChar

Return value

TBool

IMPORT_C TInt SetXOnChar(TUint8 aXOnChar);

Description

Parameters

TUint8 aXOnChar

Return value

TInt

IMPORT_C TBool GetXOffChar(TUint8 &aXOffChar) const;

Description

If XOff Char is valid, sets reference and returns True, otherwise, returns False

Parameters

TUint8 &aXOffChar

Return value

TBool

IMPORT_C TInt SetXOffChar(TUint8 aXOffChar);

Description

Parameters

TUint8 aXOffChar

Return value

TInt

IMPORT_C void UpdateFlowCtrlBit(TUint8 aFlowCtrl, TRPNFlowCtrlMask aFCMask);

Description

Constructor Set the flow control bit specified by aFCMask to the same value it has in aFlowCtrl

Parameters

TUint8 aFlowCtrl Flow control specifier. TRPNFlowCtrlMask aFCMask Flow control mask.

IMPORT_C void UpdateWholeFlowCtrl(TUint16 aParamMask, TUint8 aFlowCtrl);

Description

Used to update flow control with relevant bits from aFlowCtrl (as specified by aParamsMask)

Parameters

TUint16 aParamMask The parameter mask specifing what to change. TUint8 aFlowCtrl Flow control information specifing new values.

IMPORT_C void UpdateFromRPNTransaction(const TRfcommRPNTransaction &aRPNTransaction);

Description

Update using a TRfcommRPNTransaction class. Update all parameters according to parameters and mask in aRPNTransaction

Parameters

const TRfcommRPNTransaction &aRPNTransaction The internal values are updated according to the values held in this attribute.

See also:

• TRfcommRPNTransaction