HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
NET_NetworkCookieStore Class Reference

#include <NET_NetworkCookieStore.h>

Public Types

enum  StoragePolicy { NoPersistentCookies, AllowPersistentCookies, ForcePersistentCookies }
 
enum  Mode { Sync, Async }
 
using CookieList = UT_Array< NET_NetworkCookie >
 
using iterator = CookieList::iterator
 
using const_iterator = CookieList::const_iterator
 

Public Member Functions

 NET_NetworkCookieStore ()
 
virtual ~NET_NetworkCookieStore ()
 
void setPersistentStoragePath (const UT_StringRef &storage_location)
 
virtual bool load ()
 
virtual void loadAsync ()
 
virtual bool flush ()
 
virtual bool deleteCookie (const NET_NetworkCookie &cookie)
 
virtual bool insertCookie (const NET_NetworkCookie &cookie)
 
virtual bool updateCookie (const NET_NetworkCookie &cookie)
 
virtual CookieList cookiesForUrl (const UT_Url &url)
 
virtual bool setCookiesFromUrl (const CookieList &cookies, const UT_Url &url)
 
void deleteAllCookies ()
 
void setStoragePolicy (StoragePolicy policy)
 
void setMode (Mode mode)
 
void debugPrintStore () const
 
UT_Optional< NET_NetworkCookiefind (const NET_NetworkCookie &cookie) const
 Find a cookie in the cookie store based on the cookie identifier. More...
 
void createDBFileLocationIfNeeded ()
 
const CookieListallCookies () const
 
const UT_StringHolderpersistentStorage () const
 
bool isAsync () const
 

Static Public Member Functions

static NO_DISCARD UT_StringHolder defaultCookieStoragePath (UT_LMHost::AppType app_type, const UT_StringRef &name)
 

Protected Member Functions

void setAllCookies (const CookieList &cookies)
 
virtual NO_DISCARD bool validateCookie (const NET_NetworkCookie &cookie, const UT_Url &url) const
 

Detailed Description

Definition at line 32 of file NET_NetworkCookieStore.h.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator
Sync 
Async 

Definition at line 46 of file NET_NetworkCookieStore.h.

Enumerator
NoPersistentCookies 
AllowPersistentCookies 
ForcePersistentCookies 

Definition at line 39 of file NET_NetworkCookieStore.h.

Constructor & Destructor Documentation

NET_NetworkCookieStore::NET_NetworkCookieStore ( )
virtual NET_NetworkCookieStore::~NET_NetworkCookieStore ( )
virtual

Member Function Documentation

const CookieList& NET_NetworkCookieStore::allCookies ( ) const
inline

Definition at line 101 of file NET_NetworkCookieStore.h.

virtual CookieList NET_NetworkCookieStore::cookiesForUrl ( const UT_Url url)
virtual
void NET_NetworkCookieStore::createDBFileLocationIfNeeded ( )
void NET_NetworkCookieStore::debugPrintStore ( ) const
static NO_DISCARD UT_StringHolder NET_NetworkCookieStore::defaultCookieStoragePath ( UT_LMHost::AppType  app_type,
const UT_StringRef name 
)
static
void NET_NetworkCookieStore::deleteAllCookies ( )
virtual bool NET_NetworkCookieStore::deleteCookie ( const NET_NetworkCookie cookie)
virtual
UT_Optional<NET_NetworkCookie> NET_NetworkCookieStore::find ( const NET_NetworkCookie cookie) const

Find a cookie in the cookie store based on the cookie identifier.

virtual bool NET_NetworkCookieStore::flush ( )
virtual
virtual bool NET_NetworkCookieStore::insertCookie ( const NET_NetworkCookie cookie)
virtual
bool NET_NetworkCookieStore::isAsync ( ) const
inline

Definition at line 105 of file NET_NetworkCookieStore.h.

virtual bool NET_NetworkCookieStore::load ( )
virtual
virtual void NET_NetworkCookieStore::loadAsync ( )
virtual
const UT_StringHolder& NET_NetworkCookieStore::persistentStorage ( ) const
inline

Definition at line 103 of file NET_NetworkCookieStore.h.

void NET_NetworkCookieStore::setAllCookies ( const CookieList cookies)
protected
virtual bool NET_NetworkCookieStore::setCookiesFromUrl ( const CookieList cookies,
const UT_Url url 
)
virtual
void NET_NetworkCookieStore::setMode ( Mode  mode)
void NET_NetworkCookieStore::setPersistentStoragePath ( const UT_StringRef storage_location)
void NET_NetworkCookieStore::setStoragePolicy ( StoragePolicy  policy)
virtual bool NET_NetworkCookieStore::updateCookie ( const NET_NetworkCookie cookie)
virtual
virtual NO_DISCARD bool NET_NetworkCookieStore::validateCookie ( const NET_NetworkCookie cookie,
const UT_Url url 
) const
protectedvirtual

The documentation for this class was generated from the following file: