soma-io 6.0.6
fddatasource.h
Go to the documentation of this file.
1/* This software and supporting documentation are distributed by
2 * Institut Federatif de Recherche 49
3 * CEA/NeuroSpin, Batiment 145,
4 * 91191 Gif-sur-Yvette cedex
5 * France
6 *
7 * This software is governed by the CeCILL-B license under
8 * French law and abiding by the rules of distribution of free software.
9 * You can use, modify and/or redistribute the software under the
10 * terms of the CeCILL-B license as circulated by CEA, CNRS
11 * and INRIA at the following URL "http://www.cecill.info".
12 *
13 * As a counterpart to the access to the source code and rights to copy,
14 * modify and redistribute granted by the license, users are provided only
15 * with a limited warranty and the software's author, the holder of the
16 * economic rights, and the successive licensors have only limited
17 * liability.
18 *
19 * In this respect, the user's attention is drawn to the risks associated
20 * with loading, using, modifying and/or developing or reproducing the
21 * software by the user in light of its specific status of free software,
22 * that may mean that it is complicated to manipulate, and that also
23 * therefore means that it is reserved for developers and experienced
24 * professionals having in-depth computer knowledge. Users are therefore
25 * encouraged to load and test the software's suitability as regards their
26 * requirements in conditions enabling the security of their systems and/or
27 * data to be ensured and, more generally, to use and operate it in the
28 * same conditions as regards security.
29 *
30 * The fact that you are presently reading this means that you have had
31 * knowledge of the CeCILL-B license and that you accept its terms.
32 */
33
34#ifndef SOMAIO_DATASOURCE_FDDATASOURCE_H
35#define SOMAIO_DATASOURCE_FDDATASOURCE_H
36//--- soma-io ----------------------------------------------------------------
38#include <soma-io/datasource/datasource.h> // base class
39//----------------------------------------------------------------------------
40
41namespace soma
42{
43
46 class FDDataSource : public DataSource
47 {
48 public:
49 FDDataSource( int fd = -1, int mode = Read );
50 virtual ~FDDataSource();
51
52 virtual DataSource* clone() const;
53 virtual int iterateMode() const;
54 virtual bool isOpen() const;
56 virtual bool open ( int mode );
57 virtual void close();
58 virtual offset_t size() const;
59 virtual offset_t at() const;
60 virtual bool at( offset_t pos );
61 virtual long readBlock( char* data, unsigned long maxlen );
62 virtual long writeBlock( const char* data, unsigned long len );
63 virtual int getch();
64 virtual int putch( int ch );
65 virtual bool ungetch( int ch );
67 virtual bool allowsMemoryMapping() const;
68
69 int descriptor() const; // should it be non-const ?
70 void setDescriptor( int fd );
71 bool isFile() const;
72
73 protected:
74 int _fd;
75 };
76
77}
78
79#endif
int mode() const
access mode(s) (read/write): bitwise OR of Mode values
virtual bool allowsMemoryMapping() const
in the general case, memory mapping is not possible
virtual long writeBlock(const char *data, unsigned long len)
virtual bool isOpen() const
bool isFile() const
virtual bool at(offset_t pos)
int descriptor() const
virtual int iterateMode() const
possible iteration mode(s): bitwise OR of IterateMode values
virtual bool ungetch(int ch)
virtual int putch(int ch)
void setDescriptor(int fd)
virtual void close()
virtual int getch()
virtual DataSource * clone() const
virtual offset_t at() const
virtual offset_t size() const
virtual bool open(int mode)
useless for a file descriptor: a fd is already open
FDDataSource(int fd=-1, int mode=Read)
virtual ~FDDataSource()
virtual long readBlock(char *data, unsigned long maxlen)
unsigned long long offset_t
Offsets are 64 bits if supported.
Definition datasource.h:51