http_Header.hpp

浏览该文件的文档.

#ifndef __HTTP_HEADER_HPP__
#define __HTTP_HEADER_HPP__

namespace http
{

class HTTPWRAPPER_DLL Header
{
public:
    class HTTPWRAPPER_DLL HeaderField
    {
    public:
        HeaderField();
        HeaderField( winux::String const & fieldVal );
        HeaderField( winux::String const & firstVal, winux::Mixed const & options );

        void clear();

        virtual winux::String toString( bool semicolonSpace = true, bool commaSpace = false, bool keyNoValForceQuote = false, bool valueForceQuote = false ) const;
        HeaderField & parse( winux::String const & fieldVal );

        winux::String getOption( winux::String const & name, size_t i = 0 ) const { return i < _optionss.size() && _optionss[i].has(name) ? _optionss[i][name] : ""; }
        void setOption( winux::String const & name, winux::String const & value, size_t i = 0 );
        bool hasOption( winux::String const & name, size_t i = 0 ) const { return i < _optionss.size() && _optionss[i].has(name); }

        size_t getOptionsCount() const { return _optionss.size(); }
        winux::Mixed & getOptions( size_t i = 0 ) { return _optionss[i]; }
        winux::Mixed const & getOptions( size_t i = 0 ) const { return _optionss[i]; }

        winux::String getFirstVal( size_t i = 0 ) const;
        void setFirstVal( winux::String const & firstVal, size_t i = 0 );

    protected:
        std::vector<winux::Mixed> _optionss;
    };

    class HTTPWRAPPER_DLL ContentType : public HeaderField
    {
    public:
        ContentType() { }
        ContentType( winux::String const & fieldVal ) : HeaderField(fieldVal) { }
        ContentType( winux::String const & mimeType, winux::Mixed const & options ) : HeaderField( mimeType, options ) { }

        winux::String getMimeType() const;
        void setMimeType( winux::String const & mimeType );

        winux::String getCharset() const;
        void setCharset( winux::String const & charset );

        winux::String getBoundary() const;
        void setBoundary( winux::String const & boundary );
    };

    class HTTPWRAPPER_DLL ContentDisposition : public HeaderField
    {
    public:
        ContentDisposition() { }
        ContentDisposition( winux::String const & fieldVal ) : HeaderField(fieldVal) { }
        ContentDisposition( winux::String const & firstVal, winux::Mixed const & options ) : HeaderField( firstVal, options ) { }
    };

public:
    Header();
    Header( std::initializer_list< std::pair< winux::String, winux::Mixed > > list );
    void clear();
    winux::String toString( bool isAddCrlfAtEnd = true ) const;

    Header & parse( winux::String const & headerStr );

    winux::String const & operator [] ( winux::String const & name ) const;
    winux::String & operator [] ( winux::String const & name );

    winux::StringArray getHeaders( winux::String const & name ) const;
    winux::String getHeader( winux::String const & name, winux::String const & defval = winux::String() ) const { return _headers.has(name) ? _headers[name].refAnsi() : defval; }
    template < typename _Ty > _Ty getHeader( winux::String const & name, _Ty const & defval = _Ty() ) const { return _headers.has(name) ? (_Ty)_headers[name] : defval; }
    void addHeader( winux::String const & name, winux::String const & value );
    void setHeader( winux::String const & name, winux::String const & value ) { _headers[name] = value; }
    bool hasHeader( winux::String const & name ) const { return _headers.has(name); }
    void delHeader( winux::String const & name ) { _headers.del(name); }

    template < typename _HeaderField >
    bool get( winux::String const & name, _HeaderField * field ) const
    {
        if ( _headers.has(name) )
        {
            field->parse( *_headers[name]._pStr );
            return true;
        }
        return false;
    }
    template < typename _HeaderField >
    _HeaderField get( winux::String const & name ) const
    {
        _HeaderField f;
        f.parse( (*this)[name] );
        return f;
    }

    winux::StringWriter operator () ( winux::String const & name );

    winux::StringWriter operator () ( winux::String const & name, int i );

    winux::String getMultiHeader( winux::String const & name, int i, winux::String const & defval = winux::String() ) const;
    void addMultiHeader( winux::String const & name, winux::String const & value );
    bool hasMultiHeader( winux::String const & name ) const;
    void delMultiHeader( int index );

    void setResponseLine( winux::String const & responseLine, bool setStatus = true );

    void setRequestLine( winux::String const & requestLine );

    winux::String getStatusLine( bool isAddCrlf = false ) const;

    winux::String const & getMethod() const { return _method; }
    winux::String const & getUrl() const { return _url; }
    winux::String const & getStatusCode() const { return _statusCode; }
    winux::String const & getStatusStr() const { return _statusStr; }
    winux::String const & getVersion() const { return _version; }

    Header & setMethod( winux::String const & method ) { _method = method; return *this; }
    Header & setUrl( winux::String const & url ) { _url = url; return *this; }
    Header & setStatusCode( winux::String const & statusCode ) { _statusCode = statusCode; return *this; }
    Header & setStatusStr( winux::String const & statusStr ) { _statusStr = statusStr; return *this; }
    Header & setVersion( winux::String const & version ) { _version = version; return *this; }

    bool enumHeader( winux::String * name, winux::String * value ) const;

private:
    winux::String _method, _url; // for a request
    winux::String _statusCode, _statusStr; // for a response
    winux::String _version; // for a request/response

    winux::Mixed _headers; // 存放只能一次的头
    std::vector< std::pair< winux::String, winux::String > > _multiHeaders; // 存放可多次的头

    // 枚举相关
    mutable int _curHeaderIndex; // 当前枚举到的头部索引
    mutable int _curMultiHeaderIndex; // 当前枚举到的多头部索引
    mutable bool _isCompleteEnum; // 是否完成枚举，从而进行下一次枚举，默认是true
};

} // namespace http


#endif // __HTTP_HEADER_HPP__