source: icXML/icXML-devel/src/xercesc/util/BinInputStream.hpp @ 2732

Last change on this file since 2732 was 2722, checked in by cameron, 7 years ago

Original Xerces files with import mods for icxercesc

File size: 3.3 KB
Line 
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: BinInputStream.hpp 670359 2008-06-22 13:43:45Z borisk $
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
27XERCES_CPP_NAMESPACE_BEGIN
28
29class 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
49    /**
50     * Return the "out-of-band" content type for the data supplied by this
51     * input stream in the form of the media-type production (mime type
52     * with optional parameters such as encoding) as defined by the HTTP 1.1
53     * specification. If no such content type is provided for the data, 0 is
54     * returned. This function is expected to return the correct value at
55     * any time after the construction of the stream.
56     *
57     * An example of the stream that may return non-0 from this function is
58     * an HTTP stream with the value returned taken from the "Content-Type"
59     * HTTP header. Note also that if the encoding of the data is known
60     * to the application by some other means then the setEncoding function
61     * in the InputSource object should be used instead. The getContentType
62     * function should only be used to return information that is intrinsic
63     * to the stream.
64     *
65     * @return The content type, or 0 if one is not available.
66     */
67    virtual const XMLCh* getContentType() const = 0;
68
69
70protected :
71    // -----------------------------------------------------------------------
72    //  Hidden Constructors
73    // -----------------------------------------------------------------------
74    BinInputStream();
75
76
77private :
78    // -----------------------------------------------------------------------
79    //  Unimplemented Constructors
80    // -----------------------------------------------------------------------
81    BinInputStream(const BinInputStream&);
82    BinInputStream& operator=(const BinInputStream&);
83};
84
85XERCES_CPP_NAMESPACE_END
86
87#endif
Note: See TracBrowser for help on using the repository browser.