ulxr_http_protocol.h

Go to the documentation of this file.

/***************************************************************************
               ulxr_http_prootocol.h  -  http prootocol
                             -------------------
    begin                : Mon May 3 2004
    copyright            : (C) 2002-2007 by Ewald Arnold
    email                : ulxmlrpcpp@ewald-arnold.de

    $Id: ulxr_http_protocol.h 1014 2007-07-22 11:44:45Z ewald-arnold $

 ***************************************************************************/

/**************************************************************************
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2 of the License,
 * or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 ***************************************************************************/

#ifndef ULXR_HTTP_PROTOCOL_H
#define ULXR_HTTP_PROTOCOL_H

#include <ulxmlrpcpp/ulxmlrpcpp.h>  // always first header

#include <map>
#include <vector>

#include <ulxmlrpcpp/ulxr_protocol.h>


namespace ulxr {


class TcpIpConnection;
class ConnectorWrapperBase;

class ULXR_API_DECL0 HttpProtocol : public Protocol
{
 public:

   typedef std::map<CppString, CppString> header_property;

   HttpProtocol(Connection *conn, const CppString &hostname, unsigned hostport);

   HttpProtocol(TcpIpConnection *conn);

   virtual ~HttpProtocol();

   virtual bool responseStatus(CppString &phrase) const;

   virtual void sendRpcCall(const MethodCall &call, const CppString &resource, bool wbxml);

   virtual void sendRpcResponse(const MethodResponse &resp, bool wbxml);

   virtual void resetConnection();

   virtual State connectionMachine(char * &buffer, long &len);

   virtual void setTransmitOnly();

   virtual bool isTransmitOnly();

   virtual CppString getProtocolName();

   virtual bool hasBytesToRead() const;

   virtual bool determineClosing(const CppString &http_ver);


   void sendNegativeResponse(int status, const CppString &phrase,
                             const CppString &info = ULXR_PCHAR(""));

   void sendRequestHeader(const CppString &method,
                          const CppString &resource,
                          const CppString &type, unsigned long len,
                          bool wbxml_mode = false);

   void sendResponseHeader(int code,
                           const CppString &phrase,
                           const CppString &type,
                           unsigned long len,
                           bool wbxml_mode = false);

   CppString getUserAgent() const;

   void setUserAgent(const CppString &ua);

   virtual void rejectAuthentication(const CppString &realm);

   virtual void setMessageAuthentication(const CppString &user, const CppString &pass);

   virtual void setProxyAuthentication(const CppString &user, const CppString &pass);

   CppString getHttpProperty (const CppString &name) const;

   bool hasHttpProperty (const CppString &name) const;

   static CppString getDateStr();

   CppString getFirstHeaderLine() const;

   virtual Protocol *detach();

   void clearCookie();

   bool hasCookie() const;

   void setCookie(const CppString &cont);

   CppString getCookie() const;

   void setServerCookie(const CppString &cookie);

   CppString getServerCookie() const;

   bool hasServerCookie() const;

   void setClientCookie(const CppString &cookie);

   CppString getClientCookie() const;

   bool hasClientCookie() const;

   void setAcceptCookies(bool bAccept = true);

   bool isAcceptCookies() const;

   virtual void shutdown(int mode);

   virtual void close();

   void enableConnect(bool enable = true);

   bool isConnectEnabled() const;

   bool isConnected() const;

   void doConnect();

   void splitHeaderLine(CppString &head_version, unsigned &head_status, CppString &head_phrase);

   void writeBody(const char *data, unsigned long len);

   void writeChunk(const char *data, unsigned long len);

   void setChunkedTransfer(bool chunked);

   bool isChunkedTransfer() const;

protected:

   typedef enum
   {
     ConnChunkHeader = Protocol::ConnLast,   // 7 chunk header of a chunked transfer
     ConnChunkBody,                          // 8 data chunk of a chunked transfer
     ConnChunkBodySkip,                      // 9 skip CRLF after chunk body
     ConnChunkTerminated                     // 10 all chunks and footer received
   }
   HttpState;

   void tryConnect();

   void awaitConnect();

   bool hasClosingProperty();

   void clearHttpInfo();

   virtual bool getUserPass(CppString &user, CppString &pass) const;

   void addOneTimeHttpField(const CppString &name, const CppString &value);

   virtual void determineContentLength();

   void parseHeaderLine();

   bool checkContinue();

 private:

   void init ();

   void machine_switchToBody(char * &buffer,
                             long &len,
                             char * &chunk_start,
                             char * &chunk_cursor);

 private:

   HttpProtocol(const HttpProtocol&);
   HttpProtocol& operator=(const HttpProtocol&);  // empty!

 private:

   struct PImpl;
   PImpl *pimpl;
};


};  // namespace ulxr


#endif // ULXR_HTTP_PROTOCOL_H

---