YiNetworkConfiguration.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_NETWORK_CONFIGURATION_H_
#define _YI_NETWORK_CONFIGURATION_H_

#include "binding/YiScriptableObject.h"
#include "utility/YiString.h"

class CYINetworkConfiguration : public CYIScriptableObject
{
public:

    CYINetworkConfiguration();
    virtual ~CYINetworkConfiguration();

    void SetResponseCacheSize(uint32_t uBytes);

    void SetPersistentCacheSize(uint32_t uBytes);

    void SetHeuristicCacheExpirationEnabled(bool bEnable);

    uint32_t GetResponseCacheSize() const;

    uint32_t GetPersistentCacheSize() const;

    CYIString GetPersistentCachePath() const;

    bool IsHeuristicCacheExpirationEnabled() const;

    /*
     \details Sets whether automatic cookie handling is enabled. Automatic cookie handling is not enabled by default.

     \note Automatic cookie handling enables a cookie store where cookies are saved between requests. Session cookies are kept in the cookie store until the app is restarted and a new "session" starts. Requests must be set to use cookies to have cookies automatically added to the header by calling CYIHTTPRequest::SetUseCookies.

     \sa CYIHTTPRequest::SetUseCookies
    */
    void SetEnableCookieHandling(bool bEnableCookieHandling);

    bool IsCookieHandlingEnabled() const;

private:
    uint32_t m_nResponseCacheSize;
    uint32_t m_nPersistentCacheSize;
    mutable CYIString m_persistentCachePath;
    bool m_bUseHeuristicExpiration;
    bool m_bCookieHandlingEnabled;
};

#endif // _YI_NETWORK_CONFIGURATION_H_