ACE/ACEXML/common/HttpCharStream.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    HttpCharStream.h
   6  *
   7  *  @author Krishnakumar B <kitty@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef _ACEXML_HTTPCHARSTREAM_H_
  12 #define _ACEXML_HTTPCHARSTREAM_H_
  13
  14 #include /**/ "ace/pre.h"
  15 #include "ACEXML/common/ACEXML_Export.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 #pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #include "ACEXML/common/CharStream.h"
  22 #include "ACEXML/common/URL_Addr.h"
  23 #include "ACEXML/common/Mem_Map_Stream.h"
  24
  25 /**
  26  * @class ACEXML_HttpCharStream
  27  *
  28  * An implementation of ACEXML_CharStream for reading input from a URL.
  29  */
  30 class ACEXML_Export ACEXML_HttpCharStream : public ACEXML_CharStream
  31 {
  32 public:
  33   /// Default constructor.
  34   ACEXML_HttpCharStream ();
  35
  36   /// Destructor
  37   virtual ~ACEXML_HttpCharStream ();
  38
  39   /// Open an URL.
  40   int open (const ACEXML_Char *url);
  41
  42   /**
  43    *  Returns the available ACEXML_Char in the buffer.  -1
  44    *  if the object is not initialized properly.
  45    */
  46   virtual int available ();
  47
  48   /**
  49    *  Close this stream and release all resources used by it.
  50    */
  51   virtual int close ();
  52
  53   /**
  54    *  Read the next ACEXML_Char.  Return -1 if we are not able to
  55    *  return an ACEXML_Char, 0 if EOS is reached, or 1 if succeed.
  56    */
  57   virtual int get (ACEXML_Char& ch);
  58
  59   /**
  60    *  Read the next batch of ACEXML_Char strings
  61    */
  62   virtual int read (ACEXML_Char *str, size_t len);
  63
  64   /**
  65    *  Peek the next ACEXML_Char in the CharStream.  Return the
  66    *  character if succeess, -1 if EOS is reached.
  67    */
  68   virtual int peek ();
  69
  70   /**
  71    *  Resets the file pointer to the beginning of the stream.
  72    */
  73   virtual void rewind ();
  74
  75   /**
  76    *  Determine the encoding of the file.
  77    */
  78   virtual int determine_encoding ();
  79
  80   /**
  81    * Get the encoding of the file
  82    */
  83   virtual const ACEXML_Char* getEncoding ();
  84
  85   /*
  86    * Get the systemId for the underlying CharStream
  87    */
  88   virtual const ACEXML_Char* getSystemId ();
  89
  90
  91 private:
  92 #if defined (ACE_USES_WCHAR)
  93   /**
  94    *  Read the next character from the stream taking into account the
  95    *  encoding of the file.
  96    */
  97   int get_i (ACEXML_Char& ch);
  98
  99   /**
 100    *  Read the next character from the stream taking into account the
 101    *  encoding of the file. Subsequent call to get() returns this
 102    *  character.
 103    */
 104   int peek_i ();
 105
 106 #endif /* ACE_USES_WCHAR */
 107
 108   /**
 109    *  Send a HTTP/1.1 request to fetch the contents of the URL.
 110    */
 111   int send_request ();
 112
 113   /**
 114    *  Fetch the URL and save it in backing store.
 115    */
 116   int get_url (size_t& len);
 117
 118   ACEXML_Char *url_;
 119
 120   ACEXML_URL_Addr* url_addr_;
 121
 122   ACEXML_Mem_Map_Stream* stream_;
 123
 124   Connector* connector_;
 125
 126   ACE_OFF_T size_;
 127
 128   ACE_OFF_T data_offset_;
 129
 130   ACEXML_Char* encoding_;
 131 };
 132
 133
 134 #include /**/ "ace/post.h"
 135
 136 #endif /* _ACEXML_HTTPCHARSTREAM_H_ */