CMifareClassicConnection Class Reference

#include <mw/mifareclassicconnection.h>

class CMifareClassicConnection : public CActive, public MNfcConnection

Inherits from

CMifareClassicConnection
- CActive
  - CBase
- MNfcConnection

Public Member Functions
	~CMifareClassicConnection()
virtual IMPORT_C TInt	Activate(TInt)
virtual IMPORT_C void	CancelRawModeAccess()
virtual IMPORT_C TNfcConnectionInfo::TNfcConnectionMode	ConnectionMode()
virtual IMPORT_C void	Deactivate()
IMPORT_C TInt	Decrement(TUint8, TUint8, TUint32, const TDesC8 &, const TDesC8 &)
IMPORT_C TInt	Increment(TUint8, TUint8, TUint32, const TDesC8 &, const TDesC8 &)
virtual IMPORT_C TBool	IsActivated()
IMPORT_C CMifareClassicConnection *	NewL(RNfcServer &)
IMPORT_C CMifareClassicConnection *	NewLC(RNfcServer &)
virtual IMPORT_C void	RawModeAccess(TRequestStatus &, const TDesC8 &, TDes8 &, TTimeIntervalMicroSeconds32 &)
IMPORT_C void	ReadCancel()
IMPORT_C void	ReadDataBlock(TRequestStatus &, MMifareClassicBlock &, TUint8, TUint8, const TDesC8 &, const TDesC8 &)
IMPORT_C void	ReadSector(TRequestStatus &, CMifareClassicSector &, TUint8, const TDesC8 &, const TDesC8 &)
IMPORT_C TInt	Restore(TUint8, TUint8, const TDesC8 &, const TDesC8 &)
IMPORT_C TInt	Transfer(TUint8, TUint8, const TDesC8 &, const TDesC8 &)
IMPORT_C void	WriteCancel()
IMPORT_C void	WriteDataBlock(TRequestStatus &, const MMifareClassicBlock &, TUint8, TUint8, const TDesC8 &, const TDesC8 &)
IMPORT_C void	WriteSector(TRequestStatus &, const CMifareClassicSector &, TUint8, const TDesC8 &, const TDesC8 &)

Inherited Attributes
	CActive::iStatus

Inherited Enumerations
	CActive:TPriority

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::RunError(TInt)
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	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()
	MNfcConnection::~MNfcConnection()

Detailed Description

This class provides access to a Mifare classic tag.

{nfctagextension.lib}

Constructor & Destructor Documentation

~CMifareClassicConnection ( )

IMPORT_C

~CMifareClassicConnection

(

)

Destructor.

Member Function Documentation

Activate ( TInt )

IMPORT_C TInt

Activate

(

TInt

aHandle

)

[virtual]

Reimplemented from MNfcConnection::Activate(TInt)

See also: MNfcConnection

CancelRawModeAccess ( )

IMPORT_C void

CancelRawModeAccess

(

)

[virtual]

Reimplemented from MNfcConnection::CancelRawModeAccess()

See also: MNfcConnection

ConnectionMode ( )

IMPORT_C TNfcConnectionInfo::TNfcConnectionMode

ConnectionMode

(

)

[virtual]

Reimplemented from MNfcConnection::ConnectionMode()

See also: MNfcConnection

Deactivate ( )

IMPORT_C void

Deactivate

(

)

[virtual]

Reimplemented from MNfcConnection::Deactivate()

See also: MNfcConnection

Decrement ( TUint8, TUint8, TUint32, const TDesC8 &, const TDesC8 & )

IMPORT_C TInt	Decrement	(	TUint8	aSector,
			TUint8	aBlock,
			TUint32	aValue,
			const TDesC8 &	aKeyA = KNullDesC8,
			const TDesC8 &	aKeyB = KNullDesC8
		)

Decrements the contents of a block and stores the result in a temprary internal data register.

Parameters
aSector	Sector address. Starts from sector 0.
aBlock	Block address. Starts from block 0.
aValue	Value to decrement.
aKeyA	Authentication key A, use KNullDesC8 for factory keys
aKeyB	Authentication key B, use KNullDesC8 for factory keys

Return Values

KErrArgument	Reading failed due to tag type specific restrictions
KErrDisconnected	No tag in field.
KErrNone	The operation is successfully completed.

Increment ( TUint8, TUint8, TUint32, const TDesC8 &, const TDesC8 & )

IMPORT_C TInt	Increment	(	TUint8	aSector,
			TUint8	aBlock,
			TUint32	aValue,
			const TDesC8 &	aKeyA = KNullDesC8,
			const TDesC8 &	aKeyB = KNullDesC8
		)

Increments the content of a block and stores the result in a temporary internal data register.

Parameters
aSector	Sector address. Starts from sector 0.
aBlock	Block address. Starts from block 0.
aValue	Value to increment.
aKeyA	Authentication key A, use KNullDesC8 for factory keys
aKeyB	Authentication key B, use KNullDesC8 for factory keys

Return Values

KErrArgument	Reading failed due to tag type specific restrictions
KErrDisconnected	No tag in field.
KErrNone	The operation is successfully completed.

IsActivated ( )

IMPORT_C TBool

IsActivated

(

)

[virtual]

Reimplemented from MNfcConnection::IsActivated()

NewL ( RNfcServer & )

IMPORT_C CMifareClassicConnection *

NewL

(

RNfcServer &

aNfcServer

)

[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Parameters
aNfcServer	Reference to NFC Server.

Return Value: Pointer to the newly created instance.

NewLC ( RNfcServer & )

IMPORT_C CMifareClassicConnection *

NewLC

(

RNfcServer &

aNfcServer

)

[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Parameters
aNfcServer	Reference to NFC Server.

Return Value: Pointer to the newly created instance.

RawModeAccess ( TRequestStatus &, const TDesC8 &, TDes8 &, TTimeIntervalMicroSeconds32 & )

IMPORT_C void	RawModeAccess	(	TRequestStatus &	aStatus,
			const TDesC8 &	aCommand,
			TDes8 &	aResponse,
			TTimeIntervalMicroSeconds32 &	aTimeout
		)	[virtual]

Reimplemented from MNfcConnection::RawModeAccess(TRequestStatus &,const TDesC8 &,TDes8 &,TTimeIntervalMicroSeconds32 &)

See also: MNfcConnection

ReadCancel ( )

IMPORT_C void

ReadCancel

(

)

Cancels any read request.

ReadDataBlock ( TRequestStatus &, MMifareClassicBlock &, TUint8, TUint8, const TDesC8 &, const TDesC8 & )

IMPORT_C void	ReadDataBlock	(	TRequestStatus &	aStatus,
			MMifareClassicBlock &	aMifareClassicBlock,
			TUint8	aSector,
			TUint8	aBlock,
			const TDesC8 &	aKeyA = KNullDesC8,
			const TDesC8 &	aKeyB = KNullDesC8
		)

Reads datablock from the target Mifare Classic tag.

Only one write/read command can be requested at a time.

Parameters
aStatus	The client's request status.
aMifareClassicBlock	Block where read data is written to.
aSector	Sector address starts from sector 0.
aBlock	Block address starts from block 0.
aKeyA	Authentication key A, use KNullDesC8 for factory keys
aKeyB	Authentication key B, use KNullDesC8 for factory keys

Return Value: Return values for aStatus:

Return Values

KErrArgument	Reading failed due to tag type specific restrictions
KErrDisconnected	No tag in field.
KErrInUse	The request is issued before the previous one is completed.
KErrNone	The operation is successfully completed.
KErrServerTerminated	Server connection is terminated.

ReadSector ( TRequestStatus &, CMifareClassicSector &, TUint8, const TDesC8 &, const TDesC8 & )

IMPORT_C void	ReadSector	(	TRequestStatus &	aStatus,
			CMifareClassicSector &	aMifareClassicSector,
			TUint8	aSector,
			const TDesC8 &	aKeyA = KNullDesC8,
			const TDesC8 &	aKeyB = KNullDesC8
		)

Reads one sector from the target Mifare Classic tag.

Only one write/read command can be requested at a time.

Parameters
aStatus	The client's request status.
aMifareClassicSector	Sector where read data is written to.
aSector	Sector offset from sector 0.
aKeyA	Authentication key A, use KNullDesC8 for factory keys
aKeyB	Authentication key B, use KNullDesC8 for factory keys

Return Value: Return values for aStatus:

Return Values

KErrArgument	Reading failed due to tag type specific restrictions
KErrDisconnected	No tag in field.
KErrInUse	The request is issued before the previous one is completed.
KErrNone	The operation is successfully completed.
KErrServerTerminated	Server connection is terminated.

Restore ( TUint8, TUint8, const TDesC8 &, const TDesC8 & )

IMPORT_C TInt	Restore	(	TUint8	aSector,
			TUint8	aBlock,
			const TDesC8 &	aKeyA = KNullDesC8,
			const TDesC8 &	aKeyB = KNullDesC8
		)

Moves the contents of a temporary into the internal data-register.

Parameters
aSector	Sector address. Starts from sector 0.
aBlock	Block address. Starts from block 0.
aKeyA	Authentication key A, use KNullDesC8 for factory keys
aKeyB	Authentication key B, use KNullDesC8 for factory keys

Return Values

KErrArgument	Reading failed due to tag type specific restrictions
KErrDisconnected	No tag in field.
KErrNone	The operation is successfully completed.

Transfer ( TUint8, TUint8, const TDesC8 &, const TDesC8 & )

IMPORT_C TInt	Transfer	(	TUint8	aSector,
			TUint8	aBlock,
			const TDesC8 &	aKeyA = KNullDesC8,
			const TDesC8 &	aKeyB = KNullDesC8
		)

Writes the contents of a temporary internal data-register to a value block.

Parameters
aSector	Sector address. Starts from sector 0.
aBlock	Block address. Starts from block 0.
aKeyA	Authentication key A, use KNullDesC8 for factory keys
aKeyB	Authentication key B, use KNullDesC8 for factory keys

Return Values

KErrArgument	Reading failed due to tag type specific restrictions
KErrDisconnected	No tag in field.
KErrNone	The operation is successfully completed.

WriteCancel ( )

IMPORT_C void

WriteCancel

(

)

Cancels any write request.

WriteDataBlock ( TRequestStatus &, const MMifareClassicBlock &, TUint8, TUint8, const TDesC8 &, const TDesC8 & )

IMPORT_C void	WriteDataBlock	(	TRequestStatus &	aStatus,
			const MMifareClassicBlock &	aMifareClassicBlock,
			TUint8	aSector,
			TUint8	aBlock,
			const TDesC8 &	aKeyA = KNullDesC8,
			const TDesC8 &	aKeyB = KNullDesC8
		)

Writes one block to target Mifare Classic tag. This method can also overwrite sector trailer.

Only one write/read command can be requested at a time.

Parameters
aStatus	The client's request status.
aMifareClassicBlock	Block which will be written.
aSector	Sector offset from sector 0.
aBlock	Block offset from block 0
aKeyA	Authentication key A, use KNullDesC8 for factory keys
aKeyB	Authentication key B, use KNullDesC8 for factory keys

Return Value: Return values for aStatus:

Return Values

KErrArgument	Writing failed due to tag type specific restrictions
KErrDisconnected	No tag in field. Or block is locked and cannot be written.
KErrInUse	The request is issued before the previous one is completed.
KErrNone	The operation is successfully completed.
KErrServerTerminated	Server connection is terminated.

WriteSector ( TRequestStatus &, const CMifareClassicSector &, TUint8, const TDesC8 &, const TDesC8 & )

IMPORT_C void	WriteSector	(	TRequestStatus &	aStatus,
			const CMifareClassicSector &	aMifareClassicSector,
			TUint8	aSector,
			const TDesC8 &	aKeyA = KNullDesC8,
			const TDesC8 &	aKeyB = KNullDesC8
		)

Writes one sector to target Mifare Classic tag.

Only one write/read command can be requested at a time.

Parameters
aStatus	The client's request status.
aMifareClassicSector	Sector which will be written.
aSector	Sector offset from sector 0.
aKeyA	Authentication key A, use KNullDesC8 for factory keys
aKeyB	Authentication key B, use KNullDesC8 for factory keys

Return Value: Return values for aStatus:

Return Values

KErrArgument	Writing failed due to tag type specific restrictions
KErrDisconnected	No tag in field. Or block is locked and cannot be written.
KErrInUse	The request is issued before the previous one is completed.
KErrNone	The operation is successfully completed.
KErrNotSupportedif	trying to write 4 blocks sector to 16 blocks sector or otherwise
KErrServerTerminated	Server connection is terminated.