FileIOHandler Class Reference

Allows the web server to read from a file. More...

#include <file_io_handler.h>

Inheritance diagram for FileIOHandler:

Public Member Functions
	FileIOHandler (zmm::String filename)
	Sets the filename to work with.
virtual void	open (IN enum UpnpOpenFileMode mode)
	Opens file for reading (writing is not supported).
virtual int	read (OUT char *buf, IN size_t length)
	Reads a previously opened file sequentially.
virtual int	write (OUT char *buf, IN size_t length)
	Writes to a previously opened file.
virtual void	seek (IN off_t offset, IN int whence)
	Performs seek on an open file.
virtual void	close ()
	Close a previously opened file.
virtual void	open (enum UpnpOpenFileMode mode)
	Opens a data for the web server.
virtual int	read (char *buf, size_t length)
	Reads previously opened/initialized data sequentially.
virtual int	write (char *buf, size_t length)
	Writes to previously opened/initialized data sequentially.
virtual void	seek (off_t offset, int whence)
	Performs a seek on an open/initialized data.
void	retain ()
void	release ()
int	getRefCount ()
Static Public Member Functions
static void *	operator new (size_t size)
static void	operator delete (void *ptr)
Protected Attributes
zmm::String	filename
	Name of the file.
FILE *	f
	Handle of the file.
mt_atomic_t	_ref_count
pthread_mutex_t	mutex

---

Detailed Description

Allows the web server to read from a file.

Definition at line 39 of file file_io_handler.h.

---

Constructor & Destructor Documentation

FileIOHandler::FileIOHandler

(

zmm::String

filename

)

Sets the filename to work with.

Definition at line 54 of file file_io_handler.cc.

---

Member Function Documentation

void FileIOHandler::close

(

)

[virtual]

Close a previously opened file.

Reimplemented from IOHandler.

Definition at line 113 of file file_io_handler.cc.

References _, _Exception, f, and NULL.

int Object::getRefCount

(

)

[inherited]

Definition at line 78 of file object.cc.

References zmm::Object::_ref_count, and atomic_get().

virtual void IOHandler::open

(

enum UpnpOpenFileMode

mode

)

[virtual, inherited]

Opens a data for the web server.

Parameters:

mode

in which the data will be opened (we only support UPNP_READ)

Todo:

Genych, ya tut che to zapamyatowal kak gawno rabotaet? kto filename poluchaet??

Reimplemented in BufferedIOHandler, and IOHandlerBufferHelper.

void FileIOHandler::open

(

IN enum UpnpOpenFileMode

mode

)

[virtual]

Opens file for reading (writing is not supported).

Definition at line 59 of file file_io_handler.cc.

References _, _Exception, zmm::String::c_str(), f, filename, NULL, UPNP_READ, and UPNP_WRITE.

void Object::operator delete

(

void *

ptr

)

[static, inherited]

Definition at line 87 of file object.cc.

References FREE.

void * Object::operator new

(

size_t

size

)

[static, inherited]

Definition at line 83 of file object.cc.

References MALLOC.

virtual int IOHandler::read	(	char *	buf,
		size_t	length
	)			[virtual, inherited]

Reads previously opened/initialized data sequentially.

Parameters:

	buf	This buffer will be filled by our read functions.
	length	Number of bytes to read.

Reimplemented in IOHandlerBufferHelper.

Referenced by web_read().

int FileIOHandler::read	(	OUT char *	buf,
		IN size_t	length
	)			[virtual]

Reads a previously opened file sequentially.

Parameters:

	buf	Data from the file will be copied into this buffer.
	length	Number of bytes to be copied into the buffer.

Definition at line 81 of file file_io_handler.cc.

References f.

void Object::release

(

)

[inherited]

Definition at line 66 of file object.cc.

References zmm::Object::_ref_count, atomic_dec(), and zmm::Object::mutex.

Referenced by zmm::ArrayBase::clear(), zmm::String::operator=(), DSOHash< zmm::Array< CacheObject > >::releaseData(), DSBHash< VT >::releaseData(), DSOHash< zmm::Array< CacheObject > >::remove(), zmm::ArrayBase::remove(), zmm::ArrayBase::removeUnordered(), zmm::ArrayBase::set(), zmm::ArrayBase::~ArrayBase(), DSOHash< zmm::Array< CacheObject > >::~DSOHash(), zmm::ObjectQueue< AutoscanDirectory >::~ObjectQueue(), zmm::ObjectStack< Element >::~ObjectStack(), and zmm::String::~String().

void Object::retain

(

)

[inherited]

Definition at line 58 of file object.cc.

References zmm::Object::_ref_count, atomic_inc(), and zmm::Object::mutex.

Referenced by zmm::ArrayBase::append(), zmm::ObjectQueue< AutoscanDirectory >::enqueue(), zmm::ArrayBase::insert(), zmm::String::operator=(), zmm::ObjectStack< Element >::push(), DSOHash< zmm::Array< CacheObject > >::put(), DSBHash< VT >::put(), zmm::ArrayBase::set(), and zmm::String::String().

virtual void IOHandler::seek	(	off_t	offset,
		int	whence
	)			[virtual, inherited]

Performs a seek on an open/initialized data.

Parameters:

	offset	Number of bytes to move in the buffer. For seeking forwards positive values are used, for seeking backwards - negative. Offset must be positive if origin is set to SEEK_SET
	whence	The position to move relative to. SEEK_CUR to move relative to current position, SEEK_END to move relative to the end of file, SEEK_SET to specify an absolute offset.

Reimplemented in IOHandlerBufferHelper.

Referenced by web_seek().

void FileIOHandler::seek	(	IN off_t	offset,
		IN int	whence
	)			[virtual]

Performs seek on an open file.

Parameters:

	offset	Number of bytes to move in the file. For seeking forwards positive values are used, for seeking backwards - negative. Offset must be positive if origin is set to SEEK_SET
	whence	The position to move relative to. SEEK_CUR to move relative to current position, SEEK_END to move relative to the end of file, SEEK_SET to specify an absolute offset.

Definition at line 105 of file file_io_handler.cc.

References _, _Exception, and f.

virtual int IOHandler::write	(	char *	buf,
		size_t	length
	)			[virtual, inherited]

Writes to previously opened/initialized data sequentially.

Parameters:

	buf	Data to be written.
	length	Number of bytes to write.

virtual int FileIOHandler::write	(	OUT char *	buf,
		IN size_t	length
	)			[virtual]

Writes to a previously opened file.

Parameters:

	buf	Data from the buffer will be written to the file.
	length	Number of bytes to be written from the buffer.

Returns:

number of bytes written.

---

Field Documentation

mt_atomic_t zmm::Object::_ref_count [protected, inherited]

Definition at line 54 of file object.h.

Referenced by zmm::Object::getRefCount(), zmm::Object::Object(), zmm::Object::release(), and zmm::Object::retain().

FILE* FileIOHandler::f [protected]

Handle of the file.

Definition at line 46 of file file_io_handler.h.

Referenced by close(), open(), read(), and seek().

zmm::String FileIOHandler::filename [protected]

Name of the file.

Definition at line 43 of file file_io_handler.h.

Referenced by open().

pthread_mutex_t zmm::Object::mutex [protected, inherited]

Reimplemented in AutoscanList, AutoscanInotify, CachedURL, Dictionary_r, DVDNavReader, IOHandlerBufferHelper, ReentrantArray< T >, SingletonManager, Singleton< T >, StorageCache, MutexAutolock, Cond, ThreadExecutor, Singleton< UpdateManager >, Singleton< Timer >, Singleton< ContentDirectoryService >, Singleton< ConfigManager >, Singleton< Server >, Singleton< Runtime >, Singleton< ContentManager >, Singleton< ConnectionManagerService >, Singleton< PlayHook >, Singleton< Storage >, and Singleton< SessionManager >.

Definition at line 56 of file object.h.

Referenced by zmm::Object::Object(), zmm::Object::release(), zmm::Object::retain(), and zmm::Object::~Object().

---

The documentation for this class was generated from the following files:

• file_io_handler.h
• file_io_handler.cc