Xerces-C++: BinInputStream.hpp Source File

Xerces-C++ 3.3.0

BinInputStream.hpp
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * $Id$
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_BININPUTSTREAM_HPP)
23#define XERCESC_INCLUDE_GUARD_BININPUTSTREAM_HPP
24
25#include <xercesc/util/XMemory.hpp>
26
27 XERCES_CPP_NAMESPACE_BEGIN
28
29 class XMLUTIL_EXPORT BinInputStream : public XMemory
30{
31public :
32 // -----------------------------------------------------------------------
33 // Virtual destructor for derived classes
34 // -----------------------------------------------------------------------
35 virtual ~BinInputStream();
36
37
38 // -----------------------------------------------------------------------
39 // The virtual input stream interface
40 // -----------------------------------------------------------------------
41 virtual XMLFilePos curPos() const = 0;
42
43 virtual XMLSize_t readBytes
44 (
45 XMLByte* const toFill
46 , const XMLSize_t maxToRead
47 ) = 0;
48
67 virtual const XMLCh* getContentType() const = 0;
68
85 virtual const XMLCh *getEncoding() const;
86
87protected :
88 // -----------------------------------------------------------------------
89 // Hidden Constructors
90 // -----------------------------------------------------------------------
91 BinInputStream();
92
93
94private :
95 // -----------------------------------------------------------------------
96 // Unimplemented Constructors
97 // -----------------------------------------------------------------------
98 BinInputStream(const BinInputStream&);
99 BinInputStream& operator=(const BinInputStream&);
100};
101
102 XERCES_CPP_NAMESPACE_END
103
104#endif
XMemory.hpp
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XMLByte
unsigned char XMLByte
Definition XercesDefs.hpp:65
XMLUTIL_EXPORT
#define XMLUTIL_EXPORT
Definition XercesDefs.hpp:162
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
XMLSize_t
size_t XMLSize_t
Definition Xerces_autoconf_config.hpp:112
XMLCh
char16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
XMLFilePos
XMLUInt64 XMLFilePos
Definition Xerces_autoconf_config.hpp:139
BinInputStream
Definition BinInputStream.hpp:30
BinInputStream::readBytes
virtual XMLSize_t readBytes(XMLByte *const toFill, const XMLSize_t maxToRead)=0
BinInputStream::~BinInputStream
virtual ~BinInputStream()
BinInputStream::curPos
virtual XMLFilePos curPos() const =0
BinInputStream::getEncoding
virtual const XMLCh * getEncoding() const
Return the "out-of-band" encoding for the data supplied by this input stream.
BinInputStream::BinInputStream
BinInputStream()
BinInputStream::getContentType
virtual const XMLCh * getContentType() const =0
Return the "out-of-band" content type for the data supplied by this input stream in the form of the m...
XMemory
This class makes it possible to override the C++ memory management by adding new/delete operators to ...
Definition XMemory.hpp:41