soma-io  5.0.5
bufferdatasource.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_BUFFERDATASOURCE_H
35 #define SOMAIO_DATASOURCE_BUFFERDATASOURCE_H
36 //--- soma-io ----------------------------------------------------------------
38 #include <soma-io/datasource/datasource.h> // base class
39 //----------------------------------------------------------------------------
40 
41 namespace soma
42 {
43 
45  {
46  public:
47  BufferDataSource( char* ptr = 0, unsigned long size = 0, int mode = Read );
48  virtual ~BufferDataSource();
49 
50  virtual DataSource* clone() const;
51  virtual int iterateMode() const;
52  virtual bool isOpen() const;
53  virtual bool open ( int mode );
54  virtual void close();
55  virtual offset_t size() const;
56  virtual offset_t at() const;
57  virtual bool at( offset_t pos );
58  virtual long readBlock( char * data, unsigned long maxlen );
59  virtual long writeBlock( const char * data, unsigned long len );
60  virtual int getch();
61  virtual int putch( int ch );
62  virtual bool ungetch( int ch );
63  virtual bool allowsMemoryMapping() const;
64 
65  const char *buffer() const;
66  char *buffer();
67  void setBuffer( char* ptr, unsigned long size, int mode );
68 
69  private:
70  char *_buffer;
71  unsigned long _size;
72  unsigned long _pos;
73  };
74 
75 }
76 
77 #endif
int mode() const
access mode(s) (read/write): bitwise OR of Mode values
virtual void close()
Abstraction layer for various data sources (file, buffer, socket...).
Definition: datasource.h:64
virtual bool open(int mode)
Definition: allocator.h:48
virtual offset_t at() const
void setBuffer(char *ptr, unsigned long size, int mode)
const char * buffer() const
BufferDataSource(char *ptr=0, unsigned long size=0, int mode=Read)
virtual DataSource * clone() const
virtual long writeBlock(const char *data, unsigned long len)
virtual bool isOpen() const
virtual bool allowsMemoryMapping() const
virtual int iterateMode() const
possible iteration mode(s): bitwise OR of IterateMode values
unsigned long long offset_t
Offsets are 64 bits if supported.
Definition: datasource.h:51
virtual long readBlock(char *data, unsigned long maxlen)
virtual offset_t size() const
virtual bool ungetch(int ch)
virtual int putch(int ch)