BinURLInputStream.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:6k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  * 
  4.  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  * 
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  * 
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer. 
  13.  * 
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  * 
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:  
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  * 
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written 
  29.  *    permission, please contact apache@apache.org.
  30.  * 
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  * 
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  * 
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 1999, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /**
  57.  * $Log: BinURLInputStream.hpp,v $
  58.  * Revision 1.2  2000/02/26 07:56:36  rahulj
  59.  * Fixed the license header as pointed out by Bill Schindler <developer@bitranch.com>
  60.  *
  61.  * Revision 1.1  2000/02/17 22:06:19  rahulj
  62.  * Moved the four LibWWW files to its own sub-directory in the
  63.  * NetAccessor directory.
  64.  *
  65.  *
  66.  * Revision 1.1  2000/01/15 01:08:04  rahulj
  67.  * Added support for HTTP to the parser.
  68.  * Error handling is not very good. Also cannot guarantee that
  69.  * there are no memory leaks.
  70.  * Only tested under NT 4.0 SP 5 using libWWW 5.2.8.
  71.  *
  72.  */
  73. #if !defined(BINURLINPUTSTREAM_HPP)
  74. #define BINURLINPUTSTREAM_HPP
  75. #include <util/XMLURL.hpp>
  76. #include <util/XMLExceptMsgs.hpp>
  77. #include <util/BinInputStream.hpp>
  78. //
  79. // Forward reference the libWWW constructs here, so as to avoid including
  80. // any of the libWWW headers in this file. Just being careful in isolating
  81. // the files that explicitly need to include the libWWW headers.
  82. //
  83. struct _HTAnchor;
  84. //
  85. // This class implements the BinInputStream interface specified by the XML
  86. // parser.
  87. //
  88. class XMLUTIL_EXPORT BinURLInputStream : public BinInputStream
  89. {
  90. public :
  91.     BinURLInputStream(const XMLURL&  urlSource);
  92.     ~BinURLInputStream();
  93.     unsigned int curPos() const;
  94.     unsigned int readBytes
  95.     (
  96.                 XMLByte* const  toFill
  97.         , const unsigned int    maxToRead
  98.     );
  99.     void reset();
  100.     unsigned int bytesAvail() const;
  101. private :
  102.     // -----------------------------------------------------------------------
  103.     //  Private data members
  104.     //
  105.     //  fAnchor
  106.     //      This is the handle that LibWWW returns for the remote file that
  107.     //      is being addressed.
  108.     //  fBuffer
  109.     //      This is the array in which the data is stored after reading it
  110.     //      of the network. The maximum size of this array is decided in the
  111.     //      constructor via a file specific #define.
  112.     //  fBufferIndex
  113.     //      Its the index into fBuffer and points to the next unprocessed
  114.     //      character. When the parser asks for more data to be read of the
  115.     //      stream, then fBuffer[fBufferIndex] is the first byte returned,
  116.     //      unless fBufferIndex equals fBufferSize indicating that all
  117.     //      data in the fBuffer has been processed.
  118.     //  fBufferSize
  119.     //      This represents the extent of valid data in the fBuffer array.
  120.     //  fRemoteFileSize
  121.     //      This stores the size in bytes of the remote file addressed by
  122.     //      this URL input stream.
  123.     //  fBytesProcessed
  124.     //      Its a rolling count of the number of bytes processed off this
  125.     //      input stream. Its only reset back to zero, if the stream is
  126.     //      reset. The maximum value this can have is fRemoteFileSize.
  127.     // -----------------------------------------------------------------------
  128.     struct _HTAnchor*   fAnchor;
  129.     XMLByte*            fBuffer;
  130.     unsigned int        fBufferIndex;
  131.     unsigned int        fBufferSize;
  132.     unsigned int        fRemoteFileSize;
  133.     unsigned int        fBytesProcessed;
  134. };
  135. #endif // BINURLINPUTSTREAM_HPP