Symbian^3 Application Developer Library >

TRfcommRemotePortParams Class Reference

class TRfcommRemotePortParams

RF COMM remote port parameters.

Public Member Functions
TRfcommRemotePortParams ()
IMPORT_C TBool GetBitRate ( TBps &)
IMPORT_C TBool GetDataBits ( TDataBits &)
IMPORT_C TBool GetFlowCtrl ( TUint8 &)
IMPORT_C TBool GetParity ( TParity &)
IMPORT_C TBool GetStopBit ( TStopBits &)
IMPORT_C TBool GetXOffChar ( TUint8 &)
IMPORT_C TBool GetXOnChar ( TUint8 &)
IMPORT_C TUint8 IsValid ()
IMPORT_C TInt SetBitRate ( TBps )
IMPORT_C TInt SetDataBits ( TDataBits )
IMPORT_C TInt SetFlowCtrl ( TUint8 )
IMPORT_C TInt SetParity ( TParity )
IMPORT_C TInt SetStopBit ( TStopBits )
IMPORT_C TInt SetXOffChar ( TUint8 )
IMPORT_C TInt SetXOnChar ( TUint8 )
IMPORT_C void UpdateFlowCtrlBit ( TUint8 , TRPNFlowCtrlMask )
IMPORT_C void UpdateFromRPNTransaction (const TRfcommRPNTransaction &)
IMPORT_C void UpdateWholeFlowCtrl ( 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_C TRfcommRemotePortParams ( )

Member Functions Documentation

GetBitRate(TBps &)

IMPORT_C TBool GetBitRate ( TBps & aBitRate ) const

Parameters

TBps & aBitRate

GetDataBits(TDataBits &)

IMPORT_C TBool GetDataBits ( TDataBits & aDataBits ) const

Parameters

TDataBits & aDataBits

GetFlowCtrl(TUint8 &)

IMPORT_C TBool GetFlowCtrl ( TUint8 & aFlowCtrl ) const

Parameters

TUint8 & aFlowCtrl

GetParity(TParity &)

IMPORT_C TBool GetParity ( TParity & aParity ) const

Parameters

TParity & aParity

GetStopBit(TStopBits &)

IMPORT_C TBool GetStopBit ( TStopBits & aStopBit ) const

Parameters

TStopBits & aStopBit

GetXOffChar(TUint8 &)

IMPORT_C TBool GetXOffChar ( TUint8 & aXOffChar ) const

Parameters

TUint8 & aXOffChar

GetXOnChar(TUint8 &)

IMPORT_C TBool GetXOnChar ( TUint8 & aXOnChar ) const

Parameters

TUint8 & aXOnChar

IsValid()

IMPORT_C TUint8 IsValid ( ) const

SetBitRate(TBps)

IMPORT_C TInt SetBitRate ( TBps aBitRate )

Parameters

TBps aBitRate

SetDataBits(TDataBits)

IMPORT_C TInt SetDataBits ( TDataBits aDataBits )

Parameters

TDataBits aDataBits

SetFlowCtrl(TUint8)

IMPORT_C TInt SetFlowCtrl ( TUint8 aFlowCtrl )

Parameters

TUint8 aFlowCtrl

SetParity(TParity)

IMPORT_C TInt SetParity ( TParity aParity )

Parameters

TParity aParity

SetStopBit(TStopBits)

IMPORT_C TInt SetStopBit ( TStopBits aStopBit )

Parameters

TStopBits aStopBit

SetXOffChar(TUint8)

IMPORT_C TInt SetXOffChar ( TUint8 aXOffChar )

Parameters

TUint8 aXOffChar

SetXOnChar(TUint8)

IMPORT_C TInt SetXOnChar ( TUint8 aXOnChar )

Parameters

TUint8 aXOnChar

UpdateFlowCtrlBit(TUint8, TRPNFlowCtrlMask)

IMPORT_C void UpdateFlowCtrlBit ( TUint8 aFlowCtrl,
TRPNFlowCtrlMask aFCMask
)

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.

UpdateFromRPNTransaction(const TRfcommRPNTransaction &)

IMPORT_C void UpdateFromRPNTransaction ( const TRfcommRPNTransaction & aRPNTransaction )

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

Parameters

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

UpdateWholeFlowCtrl(TUint16, TUint8)

IMPORT_C void UpdateWholeFlowCtrl ( TUint16 aParamMask,
TUint8 aFlowCtrl
)

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.

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.