Utility library to read and write Ndef messages from/to a Type4 NFC tag
Dependents: NFC M2M_2016_STM32 MyongjiElec_capstone1 IDW01M1_Cloud_IBM ... more
Fork of NDefLib by
NDEF NFC library
This library provides an abstract API to create NDEF formatted messages and records and to read/write them from/to a Type4 NFC Tag.
Implementations
At the moment, the NDEF API is implemented by X_NUCLEO_NFC01A1 and X_NUCLEO_NFC02A1 Dynamic NFC Tag libraries respectively driving the X-NUCLEO-NFC01A1 and X-NUCLEO-NFC02A1 boards.
Message.h
- Committer:
- giovannivisentini
- Date:
- 2016-02-01
- Revision:
- 15:01fc5a4b8366
- Parent:
- 12:ed4d9b8d1410
- Child:
- 17:46899fa3d9f2
File content as of revision 15:01fc5a4b8366:
/** ****************************************************************************** * @file Message.h * @author ST / Central Labs * @version V1.0.0 * @date 6 Nov 2015 * @brief NDef Message class ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of STMicroelectronics nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************** */ #ifndef NDEFLIB_MESSAGE_H_ #define NDEFLIB_MESSAGE_H_ #include <vector> #include "Record.h" namespace NDefLib { /** * Class containing a list of {@link Record} */ class Message { public: /** * Add a ndef record to this message. * @param r Record to add */ void addRecord(Record *r) { mRecords.push_back(r); } /** * Add all the records in the list to this message. * @param addList List of records to add. */ void addRecords(const std::vector<Record*> &addList) { mRecords.insert(mRecords.end(), addList.begin(), addList.end()); } /** * Get the specific record contained by this message, NULL if not a valid index. * @param index Record index. * @return a Record object if present, otherwise NULL */ Record* operator[](const uint32_t index)const{ if (index >= mRecords.size()) return NULL; return mRecords[index]; } /** * Get the number of records in this message. * @return number of records in this message */ uint32_t getNRecords() const { return mRecords.size(); } /** * Length in bytes needed to write this message. * @return number of bytes needed to write this message */ uint16_t getByteLength() const; /** * Write message in the provided buffer * @par The first 2 bytes contain the NDEF message length. * @param[out] buffer Buffer the message must be written into. * @return number of bytes written */ uint16_t write(uint8_t *buffer) const; /** * Create a set of records from a raw buffer adding them to a message object. * @par Message buffer must NOT contain the buffer length in the first two bytes. * @param buffer Buffer containing the message record. * @param bufferLength Buffer length. * @param[in,out] Message message that will contain the new records. */ static void parseMessage(const uint8_t * const buffer, const uint16_t bufferLength, Message *message); virtual ~Message() { } private: /** * List of records contained by this message. */ std::vector<Record*> mRecords; }; } /* namespace NDefLib */ #endif /* NDEFLIB_MESSAGE_H_ */