mi32/httpmsg.h

Go to the documentation of this file.

/***************************************************************************
 * \file mi32/httpmsg.h
 * \brief HTTPMESSAGE definitions.
 *
 * \if NODOC
 * $Log: httpmsg.h_v $
 * Revision 1.20  2012/04/26 19:36:34  mju
 * Fix status_TemporaryRedirect value.
 *
 * Revision 1.19  2012/04/26 17:16:45  mju
 * Add getStatusText and fix incorrect status number.
 *
 * Revision 1.18  2012/04/09 14:37:29  mju
 * Clean up a bit, remove unnecessary hdrs.
 *
 * Revision 1.17  2011/10/26 12:50:56  mju
 * Remove redundant hdr.
 *
 * Revision 1.15  2011/04/08 20:24:54  ldyas
 * added convenience method for appending to the body
 *
 * Revision 1.14  2008/05/01 19:17:03  scowan
 * Use escapes URI if available.
 *
 * Revision 1.12  2007/04/12 17:29:19  mju
 * Added op=.
 *
 * Revision 1.11  2007/02/08 23:16:25  dwilliss
 * Added GetDestFile() method
 *
 * Revision 1.10  2007/01/24 15:05:48  dwilliss
 * Added DetachData method.
 * More documentation
 *
 * Revision 1.9  2007/01/18 21:43:32  dwilliss
 * Added GetNumBytesExpected()
 *
 * Revision 1.6  2006/02/23 20:16:58  ldyas
 * adjusted for multipart posting.
 *
 * Revision 1.3  2004/01/09 18:36:02  dwilliss
 * Added methods to get/set content char encoding
 *
 * Revision 1.1  2004/01/02 22:58:03  dwilliss
 * Initial revision
 *
 * \endif
 **************************************************************************/

#ifndef INC_MI32_HTTPMSG_H
#define INC_MI32_HTTPMSG_H

#ifndef  INC_MI32_MILIST_H
#include <mi32/milist.h>
#endif

#ifndef  INC_MI32_MISTRING_H
#include <mi32/mistring.h>
#endif


#ifdef MISYSTEMDLL
   #define CLASSLIBEXPORT MI_DLLCLASSEXPORT
#else
   #define CLASSLIBEXPORT MI_DLLCLASSIMPORT
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
class DATETIME;
class FILEPATH;
class STRUTF8;
class XMLDOC;
#endif


class CLASSLIBEXPORT HTTPMESSAGE {
   public:

      enum METHOD {
         METHOD_REPLY = 0,
         METHOD_OPTIONS  = 1,
         METHOD_GET,
         METHOD_HEAD,
         METHOD_POST,
         METHOD_PUT,
         METHOD_DELETE,
         METHOD_TRACE,
         METHOD_CONNECT,
         METHOD_NUM_METHODS = 16 // If we ever get a method #16, we have a problem
         };

      enum STATUS {
         STATUS_EmptyMessage =                  0,

         STATUS_Continue =                      100,

         STATUS_OK       =                      200,
         STATUS_Created  =                      201,
         STATUS_Accepted    =                   202,
         STATUS_NonAuthoritativeInfo =          203,
         STATUS_NoContent   =                   204,
         STATUS_ResetContent   =                205,
         STATUS_PartialContent    =             206,

         STATUS_MultipleChoices =               300, 
         STATUS_MovedPermanently =              301,
         STATUS_Found =                         302,
         STATUS_SeeOther =                      303,
         STATUS_NotModified =                   304,
         STATUS_UseProxy =                      305,
                                             // 306 unused
         STATUS_TemporaryRedirect =             307,

         STATUS_BadRequest =                    400,
         STATUS_Unauthorized =                  401,  
         STATUS_PaymentRequired =               402,
         STATUS_Forbidden =                     403,  
         STATUS_NotFound =                      404,
         STATUS_MethodNotAllowed =              405,
         STATUS_NotAcceptable =                 406,
         STATUS_ProxyAuthenticationRequired =   407,
         STATUS_RequestTimeOut =                408,
         STATUS_Conflict =                      409,
         STATUS_Gone =                          410,
         STATUS_LengthRequired =                411,
         STATUS_PreconditionFailed =            412,
         STATUS_RequestEntityTooLarge =         413,
         STATUS_RequestURITooLarge =            414,
         STATUS_UnsupportedMediaType =          415,
         STATUS_RequestedRangeNotSatisfiable =  416,
         STATUS_ExpectationFailed =             417,

         STATUS_InternalServerError =           500,
         STATUS_NotImplemented =                501,
         STATUS_BadGateway =                    502,
         STATUS_ServiceUnavailable =            503,
         STATUS_GatewayTimeOut =                504,
         STATUS_HTTPVersionNotSupported =       505
         };

      static MISTRING GetStatusText (
         STATUS status
         );

      HTTPMESSAGE ();

      HTTPMESSAGE (
         const HTTPMESSAGE& rhs
         );

      ~HTTPMESSAGE ();

      HTTPMESSAGE& operator= (
         const HTTPMESSAGE& rhs
         );

      void AddHeader (
         const STRUTF8& header
         );

      ERRVALUE AppendToBody (
         const void* data,
         int numbytes
         );
      
      ERRVALUE AppendToBody (
         const MISTRING& data
         );

      void ClearDestFile ();

      void CloseDestFile ();

      UINT8* DetachData ();

      void GenerateEscapedRequestURI (
         STRUTF8& uri
         ) const;

      ERRVALUE GetContent (
         MISTRING& mistr
         ) const;

      ERRVALUE GetContent (
         STRUTF8& mistr
         ) const;

      ERRVALUE GetContent (
         XMLDOC& mistr
         ) const;

      CHAR_ENCODING GetContentCharEncoding () const;

      bool GetContentCharEncoding (
         STRUTF8& str
         ) const;

      const char* GetContentType () const;
   
      const UINT8* GetData (
         ) const;

#ifndef GENERATING_DOXYGEN_OUTPUT
      UINT8* GetData (
         );
#endif

      const FILEPATH& GetDestFile () const;

      const STRUTF8& GetEscapedRequestURI () const;

      const MILIST<STRUTF8>& GetExtraHeaders (
         ) const;

      // Get the value of a header entry
      // Note: you cannot get the date/time entries this way
      // \param key The header to get, not including the colon
      // \return The value of the header or NULL if not found
      const char* GetHeaderString (
         const char* key
         ) const;

      bool GetKeepAlive () const;

      const DATETIME& GetMessageTime (
         ) const;

      const STRUTF8& GetMultiPartBoundary () const;

      int GetNumBytes (
         ) const;

      int GetNumBytesExpected (
         ) const;

      METHOD GetRequestMethod () const;

      const STRUTF8& GetRequestURI (
         ) const;

      STATUS GetStatusCode () const;

      const STRUTF8& GetStatusMessage () const;

      const DATETIME& GetTimeLastModified () const;

      bool HasCharEncoding () const;

      bool IsCachedResult () const;

      bool IsHeadRequest () const;

      bool IsDirectToFile () const;

      ERRVALUE Reserve (
         int size
         );

      void Reset ();

      ERRVALUE Resize (
         int size
         );

      void SetContentCharEncoding (
         CHAR_ENCODING encoding
         );

      void SetContentCharEncoding (
         const char* encoding
         );

      void SetContentType (
         const char* ContentType
         );

      void SetDestFile (
         const FILEPATH& filepath
         );
      
      void SetIsCachedResult (
         bool bCachedResult
         );

      void SetKeepAlive (
         bool bKeepAlive = true
         );
      
      void SetMessageTime (
         const DATETIME& dts
         );

      void SetRequest (
         METHOD method,
         const STRUTF8& uri,
         bool bIsEscaped = false 
         );

      void SetStatusCode (
         STATUS status
         );

      void SetStatusMessage (
         const char* msg
         );

      void SetTimeLastModified (
         const DATETIME& dts
         );

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class PRIV;
      PRIV *m_priv;
      #endif // GENERATING_DOXYGEN_OUTPUT
   };

#undef CLASSLIBEXPORT

#endif // INC_MI32_HTTPMSG_H

---