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 ST Expansion SW Team

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.

RecordType/RecordMimeType.h

Committer:
giovannivisentini
Date:
2015-12-10
Revision:
7:1ebd6049fa57
Parent:
6:739e3211749d
Child:
8:473f6e0b03df

File content as of revision 7:1ebd6049fa57:

/**
 ******************************************************************************
 * @file    RecordMimeType.h
 * @author  ST / CentralLabs
 * @version V1.0.0
 * @date    17 Nov 2015
 * @brief   RecordMimeType implementation
 ******************************************************************************
 * @attention
 *
 * <h2><center>&copy; 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_RECORDTYPE_RECORDMIMETYPE_H_
#define NDEFLIB_RECORDTYPE_RECORDMIMETYPE_H_

#include <cstring>
#include <string>

#include "NDefLib/Record.h"

namespace NDefLib {

/**
 * Record that contain a Mime type content
 */
class RecordMimeType: public Record {
public:

	static RecordMimeType* parse(const RecordHeader &header,
			const uint8_t* buffer);

	/**
	 * create a new record with a specific MIME type
	 * @param mimeType MIME type
	 * @param data content
	 * @param nDataLenght content length in byte
	 */
	RecordMimeType(const std::string &mimeType, const uint8_t *data=NULL,
			uint32_t nDataLenght=0);

	RecordMimeType(const std::string &mimeType, const std::string &data);

	virtual uint16_t write(uint8_t *buffer);

	const std::string& getMimeType() const {
		return mMimeType;
	}

	/**
	 * change the data pointer to use for this tag,
	 * with this function we copy only the data pointer, so you have must not
	 * free the object before delete this class.
	 * @param data pointer to the data to use this record
	 * @param dataLength number of byte to write in this record
	 * @par the buffer is not copyed and not free by this class
	 */
	void setMimeDataPointer(uint8_t* data, uint32_t dataLength){
		deleteMimeData();
		mData = data;
		mDataLength=dataLength;
		mRecordHeader.setPayloadLength(dataLength);
	}

	/**
	 * change the data linked with this record, with this function the
	 * data are copied inside the object
	 * @param data pointer to the data buffer
	 * @param dataLength number of byte to write
	 */
	void copyMimeData(const uint8_t* data, uint32_t dataLength);


	uint32_t getMimeDataLenght() const {
		return mDataLength;
	}

	uint8_t const* getMimeData() const {
		return mData;
	}

	virtual RecordType_t getType() const {
		return TYPE_MIME;
	} //getType

	virtual ~RecordMimeType() {
		deleteMimeData();
	};

	bool operator==(const RecordMimeType &other) const {
		return 	mMimeType==other.mMimeType &&
				mDataLength == other.mDataLength &&
				(std::memcmp(mData,other.mData,mDataLength)==0);
	}

private:

	void initializeHeaderData();

	/**
	 * delete the mData buffer if it is allocate by this class
	 */
	void deleteMimeData(){
		if(mDataToFree && mData!=NULL){
			mDataToFree=false;
			delete [] mData;
			mData=NULL;
		}//if

	}

	const std::string mMimeType;
	uint32_t mDataLength;
	uint8_t *mData;
	bool mDataToFree;

};

} /* namespace NDefLib */

#endif /* NDEFLIB_RECORDTYPE_RECORDMIMETYPE_H_ */