cel_http.h

Go to the documentation of this file.

//----------------------------------------------------------------------------
//
// (C) 2003-2006 Celartem Technology Inc. All rights reserved.
//----------------------------------------------------------------------------

#ifndef _cel_http_h_
#define _cel_http_h_

#include "cel_referable.h"
#include "cel_iostream.h"
#include "cel_storage.h"
#include "cel_string.h"
#include "cel_credprovider.h"
#include "cel_storagecache.h"

namespace Celartem
{
    class HttpConnection;
    class HttpRequestStream;
    class HttpResponseStream;

    //------------------------------------------------------------------------
    struct HttpHeaderEntry
    {
        String name;  
        String value; 
    };

    //------------------------------------------------------------------------
    typedef AdvCachedStorage HttpStorage;


    //------------------------------------------------------------------------
    enum ProxyType
    {
        proxyAuto = 0, 
        proxyManual = 1, 
        proxyDirect = 2  
    };

    //------------------------------------------------------------------------
    class HttpManager : public Referable
    {
    public:
        virtual AutoPtr<HttpConnection> createConnection(
            const String& inHostName,
            u16 inPort = 80) = 0;

        virtual AutoPtr<HttpConnection> createSecureConnection(
            const String& inHostName,
            u16 inPort = 443,
            bool inVerifyServer = false) = 0;

        virtual AutoPtr<HttpStorage> createHttpStorage(
            const String& inUrl,
            bool inVerifyServer = false,
            DuplicateStreamCallback inLoadCallback = NULL,
            void* inContext = NULL);

        virtual void setProxy(
            ProxyType inType,
            const String& inHostName = "",
            u16 inPort = 0) = 0;

        virtual CredentialProvider* getCredentialProvider() = 0;

        static AutoPtr<HttpManager> create(
            const String& inUserAgentName = NullString,
            CredentialProvider *inCredentialProvider = NULL);
        
        static String getDefaultUserAgentName();
        
        static String getUserAgentPlatformSpec();
    };

    //------------------------------------------------------------------------
    class HttpConnection : public Referable
    {
    public:
        virtual AutoPtr<HttpRequestStream> createRequestStream(
            const String& inMethod,
            const String& inRequest,
            bool inReqIsEscaped = false,
            CredentialProvider* inCredProv = NULL) = 0;

        virtual AutoPtr<HttpManager> getHttpManager() = 0;

        virtual String getHostName() const = 0;

        virtual u16 getPort() const = 0;

        virtual bool isOnSSL() const = 0;
    };

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    class HttpRequestStream : public Stream
    {
    public:
        virtual void addRequestHeader(
            const String& inHeader) = 0;

        virtual AutoPtr<HttpResponseStream> post(
            const void *inAdditionalData = NULL, size_t inSize = 0) = 0;

        virtual String getHostName() const = 0;

        virtual u16 getPort() const = 0;

        virtual bool isOnSSL() const = 0;

        virtual String getUrl() const = 0;
    };

    //------------------------------------------------------------------------
    class HttpResponseStream : public Stream
    {
    public:
        virtual unsigned int getStatusCode() const = 0;

        virtual size_t getHeaderCount() const = 0;

        virtual void getNthHeader(
            HttpHeaderEntry& outHeader, size_t inIndex) const = 0;

        virtual String getHeader(const String& inHeaderName) const = 0;

        virtual uint64_t getContentLength() const = 0;
    };

} // namespace Celartem

#endif // _cel_http_h_

---

This document is automatically generated using doxygen 1.5.4 at Fri Jun 27 18:21:54 2008.