ZFHttpRequest.h

Go to the documentation of this file.

 
#ifndef _ZFI_ZFHttpRequest_h_
#define _ZFI_ZFHttpRequest_h_
 
#include "ZFNetDef.h"
ZF_NAMESPACE_GLOBAL_BEGIN

ZFENUM_BEGIN(ZFLIB_ZFNet, ZFHttpMethod)
    ZFENUM_VALUE(GET) 
    ZFENUM_VALUE(HEAD) 
    ZFENUM_VALUE(POST) 
    ZFENUM_VALUE(PUT) 
    ZFENUM_VALUE(DELETE) 
    ZFENUM_VALUE(CONNECT) 
    ZFENUM_VALUE(OPTIONS) 
    ZFENUM_VALUE(TRACE) 
    ZFENUM_VALUE(PATCH) 
ZFENUM_SEPARATOR()
    ZFENUM_VALUE_REGISTER(GET)
    ZFENUM_VALUE_REGISTER(HEAD)
    ZFENUM_VALUE_REGISTER(POST)
    ZFENUM_VALUE_REGISTER(PUT)
    ZFENUM_VALUE_REGISTER(DELETE)
    ZFENUM_VALUE_REGISTER(CONNECT)
    ZFENUM_VALUE_REGISTER(OPTIONS)
    ZFENUM_VALUE_REGISTER(TRACE)
    ZFENUM_VALUE_REGISTER(PATCH)
ZFENUM_END(ZFLIB_ZFNet, ZFHttpMethod)
ZFENUM_REG(ZFLIB_ZFNet, ZFHttpMethod)
 
zfclassFwd _ZFP_ZFHttpRequestPrivate;
// ============================================================
zfclass ZFLIB_ZFNet ZFHttpResponse : zfextend ZFObject {
    ZFOBJECT_DECLARE(ZFHttpResponse, ZFObject)
    ZFOBJECT_PRIVATE_ALLOC("can only be created by ZFHttpRequest")
 
    
    ZFPROPERTY_ASSIGN(zfbool, success)
    ZFPROPERTY_ASSIGN(zfint, code)
    ZFPROPERTY_ASSIGN(zfstring, errorHint)
    ZFPROPERTY_ASSIGN(zfstring, body)
 
    // ============================================================
    ZFMETHOD_DECLARE_1(zfstring, header
            , ZFMP_IN(const zfstring &, key)
            )

    ZFMETHOD_DECLARE_0(zfindex, headerCount)

    ZFMETHOD_DECLARE_0(zfiter, headerIter)
    ZFMETHOD_DECLARE_1(zfstring, headerIterKey
            , ZFMP_IN(const zfiter &, it)
            )
    ZFMETHOD_DECLARE_1(zfstring, headerIterValue
            , ZFMP_IN(const zfiter &, it)
            )
 
    // ============================================================
    ZFMETHOD_DECLARE_0(zfstring, headerInfo)
    ZFMETHOD_DECLARE_0(zfstring, contentInfo)
 
protected:
    zfoverride
    virtual void objectOnInit(void);
    zfoverride
    virtual void objectOnDealloc(void);
protected:
    zfoverride
    virtual void objectInfoImplAppend(ZF_IN_OUT zfstring &ret);
 
private:
    _ZFP_ZFHttpRequestPrivate *d;
    friend zfclassFwd ZFHttpRequest;
    friend zfclassFwd _ZFP_ZFHttpRequestPrivate;
};
 
// ============================================================
zfclass ZFLIB_ZFNet ZFHttpRequest : zfextend ZFObject, zfimplement ZFTaskId {
    ZFOBJECT_DECLARE(ZFHttpRequest, ZFObject)
    ZFIMPLEMENT_DECLARE(ZFTaskId)
 
    
    ZFEVENT(OnRequestPrepare)
    ZFEVENT(OnRequest)

    ZFEVENT(OnResponsePrepare)
    ZFEVENT(OnResponse)

    ZFOBJECT_ON_INIT_DECLARE_2(
            ZFMP_IN(const zfstring &, url)
            , ZFMP_IN_OPT(ZFHttpMethod, method, v_ZFHttpMethod::e_GET)
            )

    ZFPROPERTY_ASSIGN(zftimet, timeout, 2000)

    ZFPROPERTY_ASSIGN(zfstring, url)
    ZFPROPERTY_ON_ATTACH_DECLARE(zfstring, url)

    ZFPROPERTY_ASSIGN(ZFHttpMethod, httpMethod, v_ZFHttpMethod::e_GET)
    ZFPROPERTY_ON_ATTACH_DECLARE(ZFHttpMethod, httpMethod)

    ZFMETHOD_DECLARE_STATIC_0(zfbool, httpsAvailable)
 
    // ============================================================
    ZFMETHOD_DECLARE_2(void, header
            , ZFMP_IN(const zfstring &, key)
            , ZFMP_IN(const zfstring &, value)
            )
    ZFMETHOD_DECLARE_1(void, headerRemove
            , ZFMP_IN(const zfstring &, key)
            )
    ZFMETHOD_DECLARE_1(zfstring, header
            , ZFMP_IN(const zfstring &, key)
            )

    ZFMETHOD_DECLARE_0(zfindex, headerCount)

    ZFMETHOD_DECLARE_0(zfiter, headerIter)
    ZFMETHOD_DECLARE_1(zfstring, headerIterKey
            , ZFMP_IN(const zfiter &, it)
            )
    ZFMETHOD_DECLARE_1(zfstring, headerIterValue
            , ZFMP_IN(const zfiter &, it)
            )
    ZFMETHOD_DECLARE_2(void, headerIterValue
            , ZFMP_IN_OUT(zfiter &, it)
            , ZFMP_IN(const zfstring &, value)
            )
    ZFMETHOD_DECLARE_1(void, headerIterRemove
            , ZFMP_IN_OUT(zfiter &, it)
            )
 
    // ============================================================
    ZFMETHOD_DECLARE_1(void, body
            , ZFMP_IN(const zfstring &, buf)
            )
    ZFMETHOD_DECLARE_2(void, body
            , ZFMP_IN(const void *, buf)
            , ZFMP_IN(zfindex, count)
            )

    ZFMETHOD_DECLARE_0(zfstring, body)
 
    // ============================================================
    ZFMETHOD_DECLARE_1(void, start
            , ZFMP_IN_OPT(const ZFListener &, callback, zfnull)
            )

    ZFMETHOD_DECLARE_0(void, stop)

    ZFMETHOD_DECLARE_1(zfautoT<ZFHttpResponse>, startSync
            , ZFMP_IN_OPT(zftimet, timeout, zftimetInvalid())
            )

    ZFMETHOD_DECLARE_0(zfstring, headerInfo)
    ZFMETHOD_DECLARE_0(zfstring, contentInfo)
 
protected:
    zfoverride
    virtual void objectOnInit(void);
    zfoverride
    virtual void objectOnDealloc(void);
protected:
    zfoverride
    virtual void objectInfoImplAppend(ZF_IN_OUT zfstring &ret);
 
private:
    _ZFP_ZFHttpRequestPrivate *d;
public:
    void _ZFP_ZFHttpRequest_notifyResponse(ZF_IN ZFHttpResponse *response);
};
 
// ============================================================
ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFNet, zfstring, ZFUrlEncode
        , ZFMP_IN(const zfchar *, src)
        )
ZFMETHOD_FUNC_DECLARE_2(ZFLIB_ZFNet, void, ZFUrlEncodeT
        , ZFMP_IN_OUT(zfstring &, ret)
        , ZFMP_IN(const zfchar *, src)
        )

ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFNet, zfstring, ZFUrlDecode
        , ZFMP_IN(const zfchar *, src)
        )
ZFMETHOD_FUNC_DECLARE_2(ZFLIB_ZFNet, void, ZFUrlDecodeT
        , ZFMP_IN_OUT(zfstring &, ret)
        , ZFMP_IN(const zfchar *, src)
        )

ZFMETHOD_FUNC_DECLARE_2(ZFLIB_ZFNet, zfstring, ZFUrlForParam
        , ZFMP_IN(const zfchar *, url)
        , ZFMP_IN(const ZFJson &, params)
        )
ZFMETHOD_FUNC_DECLARE_2(ZFLIB_ZFNet, void, ZFUrlParamSet
        , ZFMP_IN_OUT(zfstring &, url)
        , ZFMP_IN(const ZFJson &, params)
        )
ZFMETHOD_FUNC_DECLARE_3(ZFLIB_ZFNet, void, ZFUrlParamSet
        , ZFMP_IN_OUT(zfstring &, url)
        , ZFMP_IN(const zfchar *, key)
        , ZFMP_IN(const zfchar *, value)
        )
ZFMETHOD_FUNC_DECLARE_3(ZFLIB_ZFNet, zfstring, ZFUrlParamGet
        , ZFMP_IN(const zfchar *, url)
        , ZFMP_IN(const zfchar *, key)
        , ZFMP_IN_OPT(const zfchar *, def, zfnull)
        )
 
// ============================================================
ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFNet, zfautoT<ZFHttpResponse>, ZFHttpHeadCache
        , ZFMP_IN(const zfstring &, url)
        )
ZFMETHOD_FUNC_DECLARE_1(ZFLIB_ZFNet, zfautoT<ZFHttpResponse>, ZFHttpHeadCacheRemove
        , ZFMP_IN(const zfstring &, url)
        )
ZFMETHOD_FUNC_DECLARE_0(ZFLIB_ZFNet, void, ZFHttpHeadCacheRemoveAll)
 
ZF_NAMESPACE_GLOBAL_END
#endif // #ifndef _ZFI_ZFHttpRequest_h_