Collapse all Symbian^3 Product Developer Library

CStifTFwIfProt Class Reference

class CStifTFwIfProt : public CBase

Inherits from

CStifTFwIfProt
- CBase

Public Member Functions
	~CStifTFwIfProt()
IMPORT_C TInt	Append(const TDesC &)
IMPORT_C TInt	Append(KeywordFunc, TInt)
IMPORT_C TInt	Append(KeywordFunc, TInt, TInt)
IMPORT_C TInt	Append(KeywordFunc, TInt, const TDesC &)
IMPORT_C TInt	Append(KeywordFunc, TInt, KeywordFunc, TInt)
IMPORT_C TInt	AppendId(TUint32)
IMPORT_C TPtrC	CmdType(TInt)
IMPORT_C void	CreateL(TInt)
IMPORT_C TUint16	DstDevId()
IMPORT_C TUint32	DstId()
IMPORT_C TUint16	DstTestId()
IMPORT_C TPtrC	EventStatus(TInt)
IMPORT_C TPtrC	EventStatusParams(TInt)
IMPORT_C TPtrC	EventType(TInt)
const TDesC &	Message()
IMPORT_C TPtrC	MsgType(TInt)
IMPORT_C CStifTFwIfProt *	NewL()
IMPORT_C TPtrC	RemoteType(TInt)
IMPORT_C TPtrC	RespParam(TInt)
IMPORT_C TPtrC	ResultCategory(TInt)
IMPORT_C TPtrC	RunParams(TInt)
IMPORT_C TPtrC	RunStatus(TInt)
IMPORT_C TPtrC	RunStatusParams(TInt)
IMPORT_C TInt	SetCmdType(TCmdType)
IMPORT_C TInt	SetDstId(TUint32)
IMPORT_C TInt	SetL(const TDesC &)
IMPORT_C TInt	SetMsgType(TMsgType)
IMPORT_C TInt	SetRespType(TMsgType)
IMPORT_C TInt	SetSrcId(TUint32)
IMPORT_C TUint16	SrcDevId()
IMPORT_C TUint32	SrcId()
IMPORT_C TUint16	SrcTestId()

Private Member Functions
	CStifTFwIfProt()
void	ConstructL()
TInt	Parse(TDesC &, KeywordFunc)
void	ParseCmdResponseL()
void	ParseHeaderL()
TInt	ParseMessageL()
TInt	ParseOptArg(const TDesC &, TPtrC &, TPtrC &)
void	ParseRemoteL()
void	ParseReserveL()
void	ParseResponseL()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Public Member Enumerations
enum	TCmdType { ECmdRun, ECmdPause, ECmdResume, ECmdCancel, ECmdRequest, ECmdRelease, ECmdSendReceive, ECmdSetEvent, ECmdUnsetEvent, ECmdUnknown }
enum	TEventStatus { EEventActive, EEventSet, EEventError }
enum	TEventStatusParams { EEventResult, EEventType }
enum	TMsgType { EMsgReserve, EMsgRelease, EMsgRemote, EMsgResponse }
enum	TRemoteType { ERemotePhone, ERemoteUnknown }
enum	TRespParam { ERespResult }
enum	TResultCategory { EResultNormal = 0, EResultPanic, EResultException, EResultTimeout, EResultLeave }
enum	TRunParams { ERunModule, ERunInifile, ERunTestcasefile, ERunTestcasenum, ERunTitle }
enum	TRunStatus { ERunStarted, ERunError, ERunReady }
enum	TRunStatusParams { ERunResult, ERunCategory }

Public Attributes
union CStifTFwIfProt::@42	@43
TPtrC	iCmdDes
TCmdType	iCmdType
TPtrC	iEventName
TEventStatus	iEventStatus
TEventIf::TEventType	iEventType
TPtrC	iIniFile
TPtrC	iModule
TMsgType	iMsgType
TRemoteType	iRemoteType
TMsgType	iRespType
TInt	iResult
TResultCategory	iResultCategory
TRunStatus	iRunStatus
TPtrC	iTestCaseFile
TInt	iTestCaseNumber
TPtrC	iTitle

Private Attributes
TInt32	iDstId
CStifItemParser *	iItem
TPtr	iMessage
HBufC *	iMessageBuf
TInt32	iSrcId

Constructor & Destructor Documentation

CStifTFwIfProt()

CStifTFwIfProt

(

)

[private]

From <base_class member_description. <member_description.> From <base_class member_description>=""> C++ default constructor.

~CStifTFwIfProt()

IMPORT_C

~CStifTFwIfProt

(

)

[virtual]

Destructor.

Member Functions Documentation

Append(const TDesC &)

IMPORT_C TInt

Append

(

const TDesC &

aStr

)

Append string to message.

Parameters

const TDesC & aStr

Append(KeywordFunc, TInt)

IMPORT_C TInt	Append	(	KeywordFunc	aFunc,
			TInt	aKeyword
		)

Append keyword string to message.

Parameters

KeywordFunc aFunc
TInt aKeyword

Append(KeywordFunc, TInt, TInt)

IMPORT_C TInt	Append	(	KeywordFunc	aFunc,
			TInt	aKeyword,
			TInt	aValue
		)

Append keyword type-value string to message.

Parameters

KeywordFunc aFunc
TInt aKeyword
TInt aValue

Append(KeywordFunc, TInt, const TDesC &)

IMPORT_C TInt	Append	(	KeywordFunc	aFunc,
			TInt	aKeyword,
			const TDesC &	aStr
		)

Append keyword type-value string to message.

Parameters

KeywordFunc aFunc
TInt aKeyword
const TDesC & aStr

Append(KeywordFunc, TInt, KeywordFunc, TInt)

IMPORT_C TInt	Append	(	KeywordFunc	aFunc,
			TInt	aKeyword,
			KeywordFunc	aValueFunc,
			TInt	aValue
		)

Append keyword type-value string to message.

Parameters

KeywordFunc aFunc
TInt aKeyword
KeywordFunc aValueFunc
TInt aValue

AppendId(TUint32)

IMPORT_C TInt

AppendId

(

TUint32

aId

)

Append hexadecimal protocol identifier to message.

Parameters

TUint32 aId

CmdType(TInt)

IMPORT_C TPtrC

CmdType

(

TInt

aKeyword

)

[static]

Parameters

TInt aKeyword

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian OS constructor is private.

CreateL(TInt)

IMPORT_C void

CreateL

(

TInt

aLength = KDefaultMsgSize

)

Create message.

Parameters

TInt aLength = KDefaultMsgSize

DstDevId()

IMPORT_C TUint16

DstDevId

(

)

Get protocol destination device identifier.

DstId()

IMPORT_C TUint32

DstId

(

)

Get protocol destination identifier.

DstTestId()

IMPORT_C TUint16

DstTestId

(

)

Get protocol destination test identifier.

EventStatus(TInt)

IMPORT_C TPtrC

EventStatus

(

TInt

aKeyword

)

[static]

Parameters

TInt aKeyword

EventStatusParams(TInt)

IMPORT_C TPtrC

EventStatusParams

(

TInt

aKeyword

)

[static]

Parameters

TInt aKeyword

EventType(TInt)

IMPORT_C TPtrC

EventType

(

TInt

aKeyword

)

[static]

Parameters

TInt aKeyword

Message()

const TDesC &

Message

(

)

[inline, virtual]

MsgType(TInt)

IMPORT_C TPtrC

MsgType

(

TInt

aKeyword

)

[static]

Parameters

TInt aKeyword

NewL()

IMPORT_C CStifTFwIfProt *

NewL

(

)

[static]

Two-phased constructor.

Parse(TDesC &, KeywordFunc)

TInt	Parse	(	TDesC &	aKeyword,
			KeywordFunc	aFunc
		)	[private, static]

Parameters

TDesC & aKeyword
KeywordFunc aFunc

ParseCmdResponseL()

void

ParseCmdResponseL

(

)

[private]

ParseHeaderL()

void

ParseHeaderL

(

)

[private]

ParseMessageL()

TInt

ParseMessageL

(

)

[private]

Parsing functions.

ParseOptArg(const TDesC &, TPtrC &, TPtrC &)

TInt	ParseOptArg	(	const TDesC &	aOptArg,
			TPtrC &	aArg,
			TPtrC &	aVal
		)	[private, static]

Parameters

const TDesC & aOptArg
TPtrC & aArg
TPtrC & aVal

ParseRemoteL()

void

ParseRemoteL

(

)

[private]

ParseReserveL()

void

ParseReserveL

(

)

[private]

ParseResponseL()

void

ParseResponseL

(

)

[private]

RemoteType(TInt)

IMPORT_C TPtrC

RemoteType

(

TInt

aKeyword

)

[static]

Parameters

TInt aKeyword

RespParam(TInt)

IMPORT_C TPtrC

RespParam

(

TInt

aKeyword

)

[static]

Parameters

TInt aKeyword

ResultCategory(TInt)

IMPORT_C TPtrC

ResultCategory

(

TInt

aKeyword

)

[static]

Parameters

TInt aKeyword

RunParams(TInt)

IMPORT_C TPtrC

RunParams

(

TInt

aKeyword

)

[static]

Parameters

TInt aKeyword

RunStatus(TInt)

IMPORT_C TPtrC

RunStatus

(

TInt

aKeyword

)

[static]

Parameters

TInt aKeyword

RunStatusParams(TInt)

IMPORT_C TPtrC

RunStatusParams

(

TInt

aKeyword

)

[static]

Parameters

TInt aKeyword

SetCmdType(TCmdType)

IMPORT_C TInt

SetCmdType

(

TCmdType

aCmdType

)

Set message type.

Parameters

TCmdType aCmdType

SetDstId(TUint32)

IMPORT_C TInt

SetDstId

(

TUint32

aDstId

)

Set protocol destination identifier.

Parameters

TUint32 aDstId

SetL(const TDesC &)

IMPORT_C TInt

SetL

(

const TDesC &

aMessage

)

Set message.

Parameters

const TDesC & aMessage

SetMsgType(TMsgType)

IMPORT_C TInt

SetMsgType

(

TMsgType

aMsgType

)

Set message type.

Parameters

TMsgType aMsgType

SetRespType(TMsgType)

IMPORT_C TInt

SetRespType

(

TMsgType

aRespType

)

Set response type.

Parameters

TMsgType aRespType

SetSrcId(TUint32)

IMPORT_C TInt

SetSrcId

(

TUint32

aSrcId

)

Set protocol source identifier.

Parameters

TUint32 aSrcId

SrcDevId()

IMPORT_C TUint16

SrcDevId

(

)

Get protocol source device identifier.

SrcId()

IMPORT_C TUint32

SrcId

(

)

Get protocol source identifier.

SrcTestId()

IMPORT_C TUint16

SrcTestId

(

)

Get protocol source test identifier.

Member Enumerations Documentation

Enum TCmdType

Enumerators

ECmdRun
ECmdPause
ECmdResume
ECmdCancel
ECmdRequest
ECmdRelease
ECmdSendReceive
ECmdSetEvent
ECmdUnsetEvent
ECmdUnknown

Enum TEventStatus

Enumerators

EEventActive
EEventSet
EEventError

Enum TEventStatusParams

Enumerators

EEventResult
EEventType

Enum TMsgType

Enumerators

EMsgReserve
EMsgRelease
EMsgRemote
EMsgResponse

Enum TRemoteType

Enumerators

ERemotePhone
ERemoteUnknown

Enum TRespParam

Enumerators

ERespResult

Enum TResultCategory

Enumerators

EResultNormal = 0
EResultPanic
EResultException
EResultTimeout
EResultLeave

Enum TRunParams

Enumerators

ERunModule
ERunInifile
ERunTestcasefile
ERunTestcasenum
ERunTitle

Enum TRunStatus

Enumerators

ERunStarted
ERunError
ERunReady

Enum TRunStatusParams

Enumerators

ERunResult
ERunCategory

Member Data Documentation

union CStifTFwIfProt::@42 @43

union CStifTFwIfProt::@42

@43

TPtrC iCmdDes

TPtrC

iCmdDes

TCmdType iCmdType

TCmdType

iCmdType

TInt32 iDstId

TInt32

iDstId

[private]

TPtrC iEventName

TPtrC

iEventName

TEventStatus iEventStatus

TEventStatus

iEventStatus

TEventIf::TEventType iEventType

TEventIf::TEventType

iEventType

TPtrC iIniFile

TPtrC

iIniFile

CStifItemParser * iItem

CStifItemParser *

iItem

[private]

TPtr iMessage

TPtr

iMessage

[private]

HBufC * iMessageBuf

HBufC *

iMessageBuf

[private]

TPtrC iModule

TPtrC

iModule

TMsgType iMsgType

TMsgType

iMsgType

TRemoteType iRemoteType

TRemoteType

iRemoteType

TMsgType iRespType

TMsgType

iRespType

TInt iResult

TInt

iResult

TResultCategory iResultCategory

TResultCategory

iResultCategory

TRunStatus iRunStatus

TRunStatus

iRunStatus

TInt32 iSrcId

TInt32

iSrcId

[private]

TPtrC iTestCaseFile

TPtrC

iTestCaseFile

TInt iTestCaseNumber

TInt	iTestCaseNumber

TPtrC iTitle

TPtrC

iTitle