Class TRfcommRemotePortParams

TRfcommRemotePortParams

Support

Supported from 6.1

Description

Parameters for a Bluetooth RFCOMM port.

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

TRfcommRemotePortParams();

Description

Default constructor.

TUint8 IsValid() const;

Description

Gets a set of flags indicating which of the port parameters have been set.

Return value

TUint8 A bitmask of TRPNValidityMask values

See also:

• TRPNValidityMask

void UpdateFromRPNTransaction(const TRfcommRPNTransaction& aRPNTransaction);

Description

Sets all port parameters through a TRfcommRPNTransaction value.

All parameters marked in the mask (TRfcommRPNTransaction.iParamMask) are copied from TRfcommRPNTransaction.iPortParams into the object.

Parameters

const TRfcommRPNTransaction& aRPNTransaction Mask and parameter values to use

TBool GetBitRate(TBps& aBitRate) const;

Description

Gets the bit rate for the port.

Parameters

TBps& aBitRate On return, the bit rate

Return value

TBool True if bit rate has been set, otherwise false

TInt SetBitRate(TBps aBitRate);

Description

Sets the bit rate for the port.

Parameters

TBps aBitRate Bit rate for the port

Return value

TInt KErrArgument: invalid value for aBitRate

TBool GetDataBits(TDataBits& aDataBits) const;

Description

Gets the number of bits transmitted per character.

Parameters

TDataBits& aDataBits On return, the number of bits transmitted per character

Return value

TBool True if the number of bits transmitted per character has been set, otherwise false

TInt SetDataBits(TDataBits aDataBits);

Description

Sets the number of bits transmitted per character.

Parameters

TDataBits aDataBits The number of bits to transmit per character

Return value

TInt Always KErrNone

TBool GetFlowCtrl(TUint8& aFlowCtrl) const;

Description

Gets the flow control methods for the port.

Parameters

TUint8& aFlowCtrl On return, the flow control methods for the port. This is a bitmask of TRPNFlowCtrlMask values.

Return value

TBool True if flow control has been set, otherwise false

See also:

• TRPNFlowCtrlMask

TInt SetFlowCtrl(TUint8 aFlowCtrl);

Description

Sets the flow control methods for the port.

Parameters

TUint8 aFlowCtrl The flow control methods for the port. This is a bitmask of TRPNFlowCtrlMask values.

Return value

TInt Always KErrNone

See also:

• TRPNFlowCtrlMask

void UpdateFlowCtrlBit(TUint8 aFlowCtrl, TRPNFlowCtrlMask aFCMask);

Description

Sets or clears a specified flow control bit.

Parameters

TUint8 aFlowCtrl Value for the specified flow control bit. To set the bit, set aFlowCtrl to the relevant TRPNFlowCtrlMask value. To clear the bit, set aFlowCtrl to the bitwise complement of the relevant TRPNFlowCtrlMask value. TRPNFlowCtrlMask aFCMask The flow control bit to set or clear

void UpdateWholeFlowCtrl(TUint16 aParamMask, TUint8 aFlowCtrl);

Description

Sets or clears one or more flow control bits.

Parameters

TUint16 aParamMask Bits to set or clear. This is a bitmask of TRPNFlowCtrlMask values. TUint8 aFlowCtrl Values for the specified flow control bits. This is also a bitmask of TRPNFlowCtrlMask values.

See also:

• TRPNFlowCtrlMask

TBool GetParity(TParity& aParity) const;

Description

Gets the parity type.

Parameters

TParity& aParity On return, the parity type

Return value

TBool True if parity has been set, otherwise false

TInt SetParity(TParity aParity);

Description

Sets the parity type.

Parameters

TParity aParity The parity type to use

Return value

TInt Always KErrNone

TBool GetStopBit(TStopBits& aStopBit) const;

Description

Gets the number of stop bits transmitted.

Parameters

TStopBits& aStopBit On return, the number of stop bits transmitted

Return value

TBool True if parity has been set, otherwise false

TInt SetStopBit(TStopBits aStopBit);

Description

Sets the number of stop bits transmitted.

Parameters

TStopBits aStopBit The number of stop bits to transmit

Return value

TInt Always KErrNone

TBool GetXOnChar(TUint8& aXOnChar) const;

Description

Gets the XON character used with XON/XOFF flow control.

Parameters

TUint8& aXOnChar On return, the XON character

Return value

TBool True if an XON character has been set, otherwise false

TInt SetXOnChar(TUint8 aXOnChar);

Description

Sets the XON character used with XON/XOFF flow control.

Parameters

TUint8 aXOnChar The XON character to use

Return value

TInt Always KErrNone

TBool GetXOffChar(TUint8& aXOffChar) const;

Description

Gets the XOFF character used with XON/XOFF flow control.

Parameters

TUint8& aXOffChar On return, the XOFF character

Return value

TBool True if an XOFF character has been set, otherwise false

TInt SetXOffChar(TUint8 aXOffChar);

Description

Sets the XOFF character used with XON/XOFF flow control.

Parameters

TUint8 aXOffChar The XOFF character to use

Return value

TInt Always KErrNone