blob: 8ada39b01bee45000eeec39f4666705adbdfbf67 [file] [log] [blame]
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/callback.h"
#include "device/nfc/nfc_ndef_record.h"
namespace device {
class NfcTag;
// NfcTagTechnology represents an NFC technology that allows a certain type of
// I/O operation on an NFC tag. NFC tags can support a wide array of protocols.
// The NfcTagTechnology hierarchy allows both raw and high-level I/O operations
// on NFC tags. Do not create instances of these objects directly. Instead,
// obtain a handle directly from an NfcTag object.
class NfcTagTechnology {
// The various I/O technologies that an NFC tag can support.
enum TechnologyType {
kTechnologyTypeNfcA = 1 << 0,
kTechnologyTypeNfcB = 1 << 1,
kTechnologyTypeNfcF = 1 << 2,
kTechnologyTypeNfcV = 1 << 3,
kTechnologyTypeIsoDep = 1 << 4,
kTechnologyTypeNdef = 1 << 5
typedef uint32 TechnologyTypeMask;
virtual ~NfcTagTechnology();
// Returns true, if the underlying tag supports the NFC tag technology that
// this instance represents.
virtual bool IsSupportedByTag() const = 0;
// Returns a pointer to the associated NfcTag instance.
NfcTag* tag() const { return tag_; }
// Constructs a technology instance, where |tag| is the NFC tag that this
// instance will operate on. Clients aren't allowed to instantiate classes
// directly. They should use the static "Create" methods defined in each
// subclass to obtain the platform specific implementation.
explicit NfcTagTechnology(NfcTag* tag);
// The underlying NfcTag instance that data exchange operations through this
// instance are performed on.
NfcTag* tag_;
// NfcNdefTagTechnology allows reading and writing NDEF messages to a tag. This
// is the most commonly used data exchange format in NFC. NDEF is a data
// exchange format and is the top most layer of the protocol stack. NDEF itself
// is not a protocol; data is typically formatted in a way that is defined by
// the NDEF format and then transmitted via one of the underlying protocols.
// Hence all tags are capable of NDEF data exchange, however, all tags don't
// necessarily use NDEF to operate (e.g. a tag may contain a smart chip that
// does data processing on ISO-DEP based APDUs and ignores NDEF). This is why,
// even if a tag inherently supports NDEF, operations done via this class may
// not necessarily succeed.
class NfcNdefTagTechnology : public NfcTagTechnology {
// The ErrorCallback is used by methods to asynchronously report errors.
typedef base::Closure ErrorCallback;
~NfcNdefTagTechnology() override;
// Interface for observing changes from NFC tags related to NDEF records.
class Observer {
virtual ~Observer() {}
// This method will be called when an NDEF record |record|, stored on the
// NFC tag |tag| has been read. This method will be called multiple times
// as records are read from the tag or when the tag's records change (e.g.
// when the tag has been rewritten). All received records can be accessed by
// calling GetNdefMessage().
virtual void RecordReceived(NfcTag* tag, const NfcNdefRecord* record) {}
// Adds and removes observers for events on this NFC tag. If monitoring
// multiple tags, check the |tag| parameter of observer methods to determine
// which tag is issuing the event.
virtual void AddObserver(Observer* observer) = 0;
virtual void RemoveObserver(Observer* observer) = 0;
// NfcTagTechnology override.
bool IsSupportedByTag() const override;
// Returns all NDEF records that were received from the tag in the form of an
// NDEF message. If the returned NDEF message contains no records, this only
// means that no records have yet been received from the tag. Users should
// use this method in conjunction with the NfcTag::Observer::RecordsReceived
// method to be notified when the records are ready.
virtual const NfcNdefMessage& GetNdefMessage() const = 0;
// Writes the given NDEF message to the underlying tag, overwriting any
// existing NDEF message on it. On success, |callback| will be invoked. On
// failure, |error_callback| will be invoked. This method can fail, if the
// underlying tag does not support NDEF as a technology.
virtual void WriteNdef(const NfcNdefMessage& message,
const base::Closure& callback,
const ErrorCallback& error_callback) = 0;
// Constructs a technology instance, where |tag| is the NFC tag that this
// instance will operate on.
explicit NfcNdefTagTechnology(NfcTag* tag);
} // namespace device