Symbian^3 Product Developer Library >

TRfcommRemotePortParams Class Reference

class TRfcommRemotePortParams

RF COMM remote port parameters.

Public Member Functions
TRfcommRemotePortParams()
IMPORT_C TBoolGetBitRate(TBps &)
IMPORT_C TBoolGetDataBits(TDataBits &)
IMPORT_C TBoolGetFlowCtrl(TUint8 &)
IMPORT_C TBoolGetParity(TParity &)
IMPORT_C TBoolGetStopBit(TStopBits &)
IMPORT_C TBoolGetXOffChar(TUint8 &)
IMPORT_C TBoolGetXOnChar(TUint8 &)
IMPORT_C TUint8IsValid()
IMPORT_C TIntSetBitRate(TBps)
IMPORT_C TIntSetDataBits(TDataBits)
IMPORT_C TIntSetFlowCtrl(TUint8)
IMPORT_C TIntSetParity(TParity)
IMPORT_C TIntSetStopBit(TStopBits)
IMPORT_C TIntSetXOffChar(TUint8)
IMPORT_C TIntSetXOnChar(TUint8)
IMPORT_C voidUpdateFlowCtrlBit(TUint8, TRPNFlowCtrlMask)
IMPORT_C voidUpdateFromRPNTransaction(const TRfcommRPNTransaction &)
IMPORT_C voidUpdateWholeFlowCtrl(TUint16, TUint8)
Private Attributes
TBps iBitRate
TDataBits iDataBits
TUint8 iFlowCtrl
TUint32 iPadding1
TUint32 iPadding2
TParity iParity
TStopBits iStopBit
TUint8 iValidMask
TUint8 iXOffChar
TUint8 iXOnChar

Constructor & Destructor Documentation

TRfcommRemotePortParams()

IMPORT_CTRfcommRemotePortParams()

Member Functions Documentation

GetBitRate(TBps &)

IMPORT_C TBoolGetBitRate(TBps &aBitRate)const

Parameters

TBps & aBitRate

GetDataBits(TDataBits &)

IMPORT_C TBoolGetDataBits(TDataBits &aDataBits)const

Parameters

TDataBits & aDataBits

GetFlowCtrl(TUint8 &)

IMPORT_C TBoolGetFlowCtrl(TUint8 &aFlowCtrl)const

Parameters

TUint8 & aFlowCtrl

GetParity(TParity &)

IMPORT_C TBoolGetParity(TParity &aParity)const

Parameters

TParity & aParity

GetStopBit(TStopBits &)

IMPORT_C TBoolGetStopBit(TStopBits &aStopBit)const

Parameters

TStopBits & aStopBit

GetXOffChar(TUint8 &)

IMPORT_C TBoolGetXOffChar(TUint8 &aXOffChar)const

Parameters

TUint8 & aXOffChar

GetXOnChar(TUint8 &)

IMPORT_C TBoolGetXOnChar(TUint8 &aXOnChar)const

Parameters

TUint8 & aXOnChar

IsValid()

IMPORT_C TUint8IsValid()const

SetBitRate(TBps)

IMPORT_C TIntSetBitRate(TBpsaBitRate)

Parameters

TBps aBitRate

SetDataBits(TDataBits)

IMPORT_C TIntSetDataBits(TDataBitsaDataBits)

Parameters

TDataBits aDataBits

SetFlowCtrl(TUint8)

IMPORT_C TIntSetFlowCtrl(TUint8aFlowCtrl)

Parameters

TUint8 aFlowCtrl

SetParity(TParity)

IMPORT_C TIntSetParity(TParityaParity)

Parameters

TParity aParity

SetStopBit(TStopBits)

IMPORT_C TIntSetStopBit(TStopBitsaStopBit)

Parameters

TStopBits aStopBit

SetXOffChar(TUint8)

IMPORT_C TIntSetXOffChar(TUint8aXOffChar)

Parameters

TUint8 aXOffChar

SetXOnChar(TUint8)

IMPORT_C TIntSetXOnChar(TUint8aXOnChar)

Parameters

TUint8 aXOnChar

UpdateFlowCtrlBit(TUint8, TRPNFlowCtrlMask)

IMPORT_C voidUpdateFlowCtrlBit(TUint8aFlowCtrl,
TRPNFlowCtrlMaskaFCMask
)

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

Parameters

TUint8 aFlowCtrlFlow control specifier.
TRPNFlowCtrlMask aFCMaskFlow control mask.

UpdateFromRPNTransaction(const TRfcommRPNTransaction &)

IMPORT_C voidUpdateFromRPNTransaction(const TRfcommRPNTransaction &aRPNTransaction)

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

Parameters

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

UpdateWholeFlowCtrl(TUint16, TUint8)

IMPORT_C voidUpdateWholeFlowCtrl(TUint16aParamMask,
TUint8aFlowCtrl
)

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

Parameters

TUint16 aParamMaskThe parameter mask specifing what to change.
TUint8 aFlowCtrlFlow control information specifing new values.

Member Data Documentation

TBps iBitRate

TBps iBitRate[private]

TDataBits iDataBits

TDataBits iDataBits[private]

TUint8 iFlowCtrl

TUint8 iFlowCtrl[private]

TUint32 iPadding1

TUint32 iPadding1[private]

TUint32 iPadding2

TUint32 iPadding2[private]

TParity iParity

TParity iParity[private]

TStopBits iStopBit

TStopBits iStopBit[private]

TUint8 iValidMask

TUint8 iValidMask[private]

TUint8 iXOffChar

TUint8 iXOffChar[private]

TUint8 iXOnChar

TUint8 iXOnChar[private]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.