CNdefConnection Class Reference

#include <mw/ndefconnection.h>

Link against: ndefaccess.lib

class CNdefConnection : public CActive

Inherits from

CNdefConnection

Public Member Functions
	~CNdefConnection()
IMPORT_C TInt	Activate(TInt)
IMPORT_C void	CancelRawModeAccess()
IMPORT_C void	CancelRead()
IMPORT_C void	CancelWrite()
IMPORT_C TNfcConnectionInfo::TNfcConnectionMode	ConnectionMode()
IMPORT_C void	Deactivate()
IMPORT_C TBool	IsActivated()
IMPORT_C TBool	IsEmptyL()
IMPORT_C TInt32	NdefMemorySize()
IMPORT_C CNdefConnection *	NewL(RNfcServer &, MNdefHandler &)
IMPORT_C CNdefConnection *	NewLC(RNfcServer &, MNdefHandler &)
IMPORT_C void	RawModeAccess(TRequestStatus &, const TDesC8 &, TDes8 &, TTimeIntervalMicroSeconds32 &)
IMPORT_C TInt	ReadMessage()
IMPORT_C TInt	ReadMessages()
IMPORT_C TInt	ReadRecord()
IMPORT_C TInt	WriteMessage(const CNdefMessage &)
IMPORT_C TInt	WriteMessages(const RPointerArray< CNdefMessage > &)

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

CNdefConnection interface provides the basic functionality for exchanging NFC Forum formatted data with contactless targets.

Before NDEF data exchange NDEF connection must be opened. Usually NDEF connection is opened with a tag. This requires tag subscription and listening of tag connection. NDEF connection is opened by giving CNdefConnection object to MNfcTag::OpenConnection as a parameter.

Since: S60 ?S60_version

Constructor & Destructor Documentation

~CNdefConnection ( )

IMPORT_C

~CNdefConnection

(

)

Destructor.

Member Function Documentation

Activate ( TInt )

IMPORT_C TInt

Activate

(

TInt

aHandle

)

CancelRawModeAccess ( )

IMPORT_C void

CancelRawModeAccess

(

)

Not supported.

CancelRead ( )

IMPORT_C void

CancelRead

(

)

Cancel read request.

CancelWrite ( )

IMPORT_C void

CancelWrite

(

)

Cancel write request.

ConnectionMode ( )

IMPORT_C TNfcConnectionInfo::TNfcConnectionMode

ConnectionMode

(

)

Deactivate ( )

IMPORT_C void

Deactivate

(

)

IsActivated ( )

IMPORT_C TBool

IsActivated

(

)

IsEmptyL ( )

IMPORT_C TBool

IsEmptyL

(

)

Check whether NDEF connection is empty or not. Usually NDEF connection is a tag. So this checks if tag is empty.

May leave with system wide error code.

Return Values

EFalse	if NDEF connection isn't empty.
ETrue	If NDEF connection is empty.

NdefMemorySize ( )

IMPORT_C TInt32

NdefMemorySize

(

)

Gets NDEF memory size.

Returns: Represent NDEF memory size in bytes when return value is positive. Negative value represent system wide error code.

NewL ( RNfcServer &, MNdefHandler & )

IMPORT_C CNdefConnection *	NewL	(	RNfcServer &	aNfcServer,
			MNdefHandler &	aHandler
		)	[static]

Creates a new instance of this class.

May leave with one of the system wide error codes.

Parameter	Description
aNfcServer	reference to NFC Server.
aHandler	Handler for callbacks.

Returns: Pointer to the newly created instance.

NewLC ( RNfcServer &, MNdefHandler & )

IMPORT_C CNdefConnection *	NewLC	(	RNfcServer &	aNfcServer,
			MNdefHandler &	aHandler
		)	[static]

Creates a new instance of this class.

May leave with one of the system wide error codes.

Parameter	Description
aNfcServer	reference to NFC Server.
aHandler	Handler for callbacks.

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
		)

Not supported.

ReadMessage ( )

IMPORT_C TInt

ReadMessage

(

)

Asynchronous read which attempts to read a NDEF Message from the target device. When read is complete MNdefHandler::ReadComplete( CNdefMessage* aMessage ) will be called. If an error occurs MNdefHandler::HandleError() will be called.

May return one of the system wide error codes.

Return Values

KErrInUse	Previous request pending.
KErrNone	Request ok.

ReadMessages ( )

IMPORT_C TInt

ReadMessages

(

)

Asynchronous read which attempts to read all NDEF Messages from the target device. When read is complete MNdefHandler::ReadComplete( const RPointerArray<CNdefMessage>& aMessages ) will be called. If an error occurs MNdefHandler::HandleError() will be called.

May return one of the system wide error codes.

Return Values

KErrInUse	Previous request pending.
KErrNone	Request ok.

ReadRecord ( )

IMPORT_C TInt

ReadRecord

(

)

Asynchronous read which attempts to read a NDEF Record from the target device. When read is complete MNdefHandler::ReadComplete( CNdefRecord* aRecord, CNdefRecord::TNdefMessagePart aPart ) will be called. If an error occures MNdefHandler::HandleError() will be called.

May return one of the system wide error codes.

Return Values

KErrInUse	Previous request pending.
KErrNone	Request ok.

WriteMessage ( const CNdefMessage & )

IMPORT_C TInt

WriteMessage

(

const CNdefMessage &

aMessage

)

Asynchronous write which attempts to write a NDEF Message to the target device. When writing has been completed MNdefHandler::WriteComplete() will be called. If an error occures MNdefHandler::HandleError() will be called.

May return one of the system wide error codes.

Parameter	Description
aMessage	Message to write.

Return Values

KErrInUse	Previous request pending.
KErrNone	Request ok.

WriteMessages ( const RPointerArray< CNdefMessage > & )

IMPORT_C TInt

WriteMessages

(

const RPointerArray< CNdefMessage > &

aMessages

)

Asynchronous write which attempts to write several NDEF Messages to the target device. When writing has been completed MNdefHandler::WriteComplete() will be called. If an error occurs MNdefHandler::HandleError() will be called.

May return one of the system wide error codes.

Return Values

KErrInUse	Previous request pending.
KErrNone	Request ok.