soma::FDDataSource Class Reference

File Descriptor data source: base class for all sources based on a file descriptor. More...

#include <soma-io/datasource/fddatasource.h>

Inheritance diagram for soma::FDDataSource:

Collaboration diagram for soma::FDDataSource:

Public Member Functions
	FDDataSource (int fd=-1, int mode=Read)
virtual	~FDDataSource ()
virtual DataSource *	clone () const
virtual int	iterateMode () const
	possible iteration mode(s): bitwise OR of IterateMode values More...
virtual bool	isOpen () const
virtual bool	open (int mode)
	useless for a file descriptor: a fd is already open More...
virtual void	close ()
virtual offset_t	size () const
virtual offset_t	at () const
virtual bool	at (offset_t pos)
virtual long	readBlock (char *data, unsigned long maxlen)
virtual long	writeBlock (const char *data, unsigned long len)
virtual int	getch ()
virtual int	putch (int ch)
virtual bool	ungetch (int ch)
virtual bool	allowsMemoryMapping () const
	in the general case, memory mapping is not possible More...
int	descriptor () const
void	setDescriptor (int fd)
bool	isFile () const
Public Member Functions inherited from soma::DataSource
	DataSource ()
virtual	~DataSource ()
int	mode () const
	access mode(s) (read/write): bitwise OR of Mode values More...
virtual bool	eof () const
virtual bool	operator! () const
virtual	operator bool () const
virtual void	flush ()
virtual bool	atEnd () const
bool	reset ()
virtual std::string	url () const
Public Member Functions inherited from carto::RCObject
	RCObject ()
	RCObject (const RCObject &)
RCObject &	operator= (const RCObject &)
virtual	~RCObject ()

Protected Attributes
int	_fd
Protected Attributes inherited from soma::DataSource
int	_mode

Additional Inherited Members
Public Types inherited from soma::DataSource
enum	Mode { Read = 1 , Write = 2 , ReadWrite = 3 }
enum	IterateMode { DirectAccess = 1 , SequentialAccess = 2 }
Public Types inherited from carto::RCObject
typedef int	RefCounterType
Static Public Member Functions inherited from soma::DataSource
static const carto::rc_ptr< DataSource >	none ()
	An empty ref-counter that is more convenient than calling a constructor of rc_ptr<DataSource> (useful when calling functions) More...

Detailed Description

File Descriptor data source: base class for all sources based on a file descriptor.

Definition at line 46 of file fddatasource.h.

Constructor & Destructor Documentation

FDDataSource()

soma::FDDataSource::FDDataSource	(	int	fd = -1,
		int	mode = Read
	)

~FDDataSource()

virtual soma::FDDataSource::~FDDataSource ( )

virtual

Member Function Documentation

allowsMemoryMapping()

virtual bool soma::FDDataSource::allowsMemoryMapping ( ) const

virtual

in the general case, memory mapping is not possible

Implements soma::DataSource.

Reimplemented in soma::FileDataSource.

at() [1/2]

virtual offset_t soma::FDDataSource::at ( ) const

virtual

Implements soma::DataSource.

Reimplemented in soma::FileDataSource.

at() [2/2]

virtual bool soma::FDDataSource::at ( offset_t  pos )

virtual

Implements soma::DataSource.

Reimplemented in soma::FileDataSource.

clone()

virtual DataSource* soma::FDDataSource::clone ( ) const

virtual

Implements soma::DataSource.

Reimplemented in soma::FileDataSource.

close()

virtual void soma::FDDataSource::close ( )

virtual

Implements soma::DataSource.

descriptor()

int soma::FDDataSource::descriptor

(

)

const

getch()

virtual int soma::FDDataSource::getch ( )

virtual

Implements soma::DataSource.

isFile()

bool soma::FDDataSource::isFile

(

)

const

isOpen()

virtual bool soma::FDDataSource::isOpen ( ) const

virtual

Implements soma::DataSource.

iterateMode()

virtual int soma::FDDataSource::iterateMode ( ) const

virtual

possible iteration mode(s): bitwise OR of IterateMode values

Implements soma::DataSource.

open()

virtual bool soma::FDDataSource::open ( int  mode )

virtual

useless for a file descriptor: a fd is already open

Implements soma::DataSource.

Reimplemented in soma::FileDataSource.

putch()

virtual int soma::FDDataSource::putch ( int  ch )

virtual

Implements soma::DataSource.

readBlock()

virtual long soma::FDDataSource::readBlock ( char *  data, unsigned long  maxlen  )

virtual

Implements soma::DataSource.

setDescriptor()

void soma::FDDataSource::setDescriptor

(

int

fd

)

size()

virtual offset_t soma::FDDataSource::size ( ) const

virtual

Implements soma::DataSource.

Reimplemented in soma::FileDataSource.

ungetch()

virtual bool soma::FDDataSource::ungetch ( int  ch )

virtual

Implements soma::DataSource.

writeBlock()

virtual long soma::FDDataSource::writeBlock ( const char *  data, unsigned long  len  )

virtual

Implements soma::DataSource.

Member Data Documentation

_fd

int soma::FDDataSource::_fd

protected

Definition at line 74 of file fddatasource.h.

---

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

• soma-io/datasource/fddatasource.h