ktorrent/libktorrent/torrent/dndfile.h

/***************************************************************************
 *   Copyright (C) 2005 by Joris Guisson                                   *
 *   joris.guisson@gmail.com                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.             *
 ***************************************************************************/
#ifndef BTDNDFILE_H
#define BTDNDFILE_H

#include <tqstring.h>
#include <util/constants.h>

namespace bt
{
	

	/**
	 * @author Joris Guisson <joris.guisson@gmail.com>
	 * 
	 * Special file where we keep the first and last chunk of a file which is marked as do not download.
	 * THe first and last chunk of a file will most certainly be partial chunks.
	 */
	class DNDFile
	{
	public:
		DNDFile(const TQString & path);
		virtual ~DNDFile();
		
		/// Change the path of the file
		void changePath(const TQString & npath);
		
		/**
		 * CHeck integrity of the file, create it if it doesn't exist.
		 */
		void checkIntegrity();
		
		/**
		 * Read the (partial)first chunk into a buffer.
		 * @param buf The buffer
		 * @param off OFfset into the buffer
		 * @param buf_size Size of the buffer
		*/
		Uint32 readFirstChunk(Uint8* buf,Uint32 off,Uint32 buf_size);
		
		/**
		 * Read the (partial)last chunk into a buffer.
		 * @param buf The buffer
		 * @param off OFfset into the buffer
		 * @param buf_size Size of the buffer
		 */
		Uint32 readLastChunk(Uint8* buf,Uint32 off,Uint32 buf_size);
		
		/**
		 * Write the partial first chunk.
		 * @param buf The buffer
		 * @param fc_size Size to write
		 */
		void writeFirstChunk(const Uint8* buf,Uint32 fc_size);
		
		/**
		 * Write the partial last chunk.
		 * @param buf The buffer
		 * @param lc_size Size to write
		 */
		void writeLastChunk(const Uint8* buf,Uint32 lc_size);
		
	private:
		void create();

	private:
		TQString path;
	};

}

#endif