CNfcType2Connection Class Reference

#include <mw/nfctype2connection.h>

Link against: nfctagextension.lib

class CNfcType2Connection : public CActive

Inherits from

CNfcType2Connection

Public Member Functions
	~CNfcType2Connection()
IMPORT_C TInt	Activate(TInt)
IMPORT_C void	CancelRawModeAccess()
IMPORT_C TNfcConnectionInfo::TNfcConnectionMode	ConnectionMode()
IMPORT_C void	Deactivate()
IMPORT_C TBool	IsActivated()
IMPORT_C TInt	IsWritable(const TInt, TBool &)
IMPORT_C TInt	LockBlock(TInt)
IMPORT_C TInt	LockTag()
IMPORT_C CNfcType2Connection *	NewL(RNfcServer &)
IMPORT_C CNfcType2Connection *	NewLC(RNfcServer &)
IMPORT_C void	RawModeAccess(TRequestStatus &, const TDesC8 &, TDes8 &, TTimeIntervalMicroSeconds32 &)
IMPORT_C void	Read(TRequestStatus &, TDes8 &, TUint, const TNfcType2Address &)
IMPORT_C void	ReadCancel()
IMPORT_C void	Write(TRequestStatus &, const TDesC8 &, TUint32)
IMPORT_C void	WriteCancel()

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()

Detailed Description

This interface provides access to a NFC Forum Type 2 tag.

Constructor & Destructor Documentation

~CNfcType2Connection ( )

IMPORT_C

~CNfcType2Connection

(

)

Destructor.

Member Function Documentation

Activate ( TInt )

IMPORT_C TInt

Activate

(

TInt

aHandle

)

See also: MNfcConnection

CancelRawModeAccess ( )

IMPORT_C void

CancelRawModeAccess

(

)

See also: MNfcConnection

ConnectionMode ( )

IMPORT_C TNfcConnectionInfo::TNfcConnectionMode

ConnectionMode

(

)

See also: MNfcConnection

Deactivate ( )

IMPORT_C void

Deactivate

(

)

See also: MNfcConnection

IsActivated ( )

IMPORT_C TBool

IsActivated

(

)

See also: MNfcConnection

IsWritable ( const TInt, TBool & )

IMPORT_C TInt	IsWritable	(	const TInt	aBlockNumber,
			TBool &	aWritable
		)

Checks whether a given block is writable. Currently no support for dynamic memory area.

Parameter	Description
aBlockNumber	Blocknumber to block which writable status will be checked.
aWritable	Return value. ETrue when the block is writable. EFalse The block is not writable.

Return Values

KErrDisconnected	No tag in field.
KErrNone	The operation is successfully completed.
KErrNotSupported	aBlock parameter is invalid
KErrServerTerminated	Server connection is terminated.

LockBlock ( TInt )

IMPORT_C TInt

LockBlock

(

TInt

aBlockNumber

)

Locks a single block on a NFC Forum Type 2 tag so that the contents of the block cannot be changed anymore. Currently no support for dynamic memory area.

Parameter	Description
aBlockNumber	Block number to be locked.

Return Values

KErrDisconnected	No tag in field.
KErrNone	The operation is successfully completed.
KErrNotSupported	aBlockNumber parameter is invalid.
KErrServerTerminated	Server connection is terminated.

LockTag ( )

IMPORT_C TInt

LockTag

(

)

Locks the entire tag. Currently no support for dynamic memory area.

Return Values

KErrDisconnected	No tag in field.
KErrNone	The operation is successfully completed.
KErrNotSupported	aBlockNumber parameter is invalid.
KErrServerTerminated	Server connection is terminated.

NewL ( RNfcServer & )

IMPORT_C CNfcType2Connection *

NewL

(

RNfcServer &

aNfcServer

)

[static]

Creates a new instance of this class.

May leave with one of the system wide error codes.

Returns: Pointer to the newly created instance.

NewLC ( RNfcServer & )

IMPORT_C CNfcType2Connection *

NewLC

(

RNfcServer &

aNfcServer

)

[static]

Creates a new instance of this class.

May leave with one of the system wide error codes.

Returns: 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
		)

See also: MNfcConnection

Read ( TRequestStatus &, TDes8 &, TUint, const TNfcType2Address & )

IMPORT_C void	Read	(	TRequestStatus &	aStatus,
			TDes8 &	aBuffer,
			TUint	aAmount,
			const TNfcType2Address &	aAddress
		)

Reads data from the target NFC Forum Type 2 tag. The read address is specified by aBlock parameter.

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

Parameter	Description
aStatus	The client's request status.
aBuffer	Descriptor for data.
aAmount	Length of data to be read.
aAddress	Address where the read operation will start.

Returns: Return values for aStatus:

Return Values

KErrArgument	aBuffer size was too small.
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.

ReadCancel ( )

IMPORT_C void

ReadCancel

(

)

Cancels any read request.

Write ( TRequestStatus &, const TDesC8 &, TUint32 )

IMPORT_C void	Write	(	TRequestStatus &	aStatus,
			const TDesC8 &	aBuffer,
			TUint32	aBlock
		)

Writes data to the target NFC Forum Type 2 tag. Only one write/read command can be requested at a time.

Parameter	Description
aStatus	The client's request status.
aBuffer	Descriptor which contains data to be written. The length of the descriptor must be multiple of four bytes.

Returns: 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.

WriteCancel ( )

IMPORT_C void

WriteCancel

(

)

Cancels any write request.