HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
NET_NetworkCookieStore Class Reference

#include <NET_NetworkCookieStore.h>

+ Inheritance diagram for NET_NetworkCookieStore:

Classes

struct  PrivateCtorTag
 
class  UniqueKey
 

Public Types

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

Public Member Functions

 NET_NetworkCookieStore (const PrivateCtorTag &, const ASIO_AnyExecutor &exc)
 
 ~NET_NetworkCookieStore ()
 
 UT_NON_COPYABLE (NET_NetworkCookieStore)
 
void configure (const UT_StringHolder &storage, StoragePolicy policy)
 
void shutdown ()
 
bool load ()
 
bool flush ()
 
bool deleteCookie (const NET_NetworkCookie &cookie)
 
bool insertCookie (const NET_NetworkCookie &cookie)
 
void notifyInsert_ (const NET_NetworkCookie &cookie)
 
bool updateCookie (const NET_NetworkCookie &cookie)
 
bool updateCookieAccess (const NET_NetworkCookie &cookie)
 
CookieList cookiesForUrl (const UT_Url &url) const
 
bool setCookiesFromUrl (const CookieList &cookies, const UT_Url &url)
 
void deleteAllCookies ()
 
void setStoragePolicy (StoragePolicy policy)
 
void debugPrintStore () const
 
UT_Optional< NET_NetworkCookie > find (const NET_NetworkCookie &cookie) const
 Find a cookie in the cookie store based on the cookie identifier. More...
 
CookieList allCookies () const
 
bool filter (NET_CookieList &cookies, const UT_StringRef &name) const
 
void attachObserver (const UT_SharedPtr< NET_INetworkCookieStoreObserver > &observer)
 
void detachObserver (const UT_SharedPtr< NET_INetworkCookieStoreObserver > &observer)
 

Static Public Member Functions

template<typename ExecutionContext , typename = typename std::enable_if_t<std::is_convertible_v< ExecutionContext &, hboost::asio::execution_context &>>>
static UT_SharedPtr
< NET_NetworkCookieStore > 		create (ExecutionContext &ctx, const UT_StringHolder &filename, StoragePolicy policy)
 
static UT_SharedPtr
< NET_NetworkCookieStore > 		create (const ASIO_AnyExecutor &exc, const UT_StringHolder &filename, StoragePolicy policy)
 
template<typename ExecutionContext , typename = typename std::enable_if_t<std::is_convertible_v< ExecutionContext &, hboost::asio::execution_context &>>>
static UT_SharedPtr
< NET_NetworkCookieStore > 		create (ExecutionContext &ctx)
 
static UT_SharedPtr
< NET_NetworkCookieStore > 		create (const ASIO_AnyExecutor &exc)
 

Detailed Description

Definition at line 91 of file NET_NetworkCookieStore.h.

Member Typedef Documentation

using NET_NetworkCookieStore::const_iterator = CookieList::const_iterator

Definition at line 103 of file NET_NetworkCookieStore.h.

using NET_NetworkCookieStore::CookieList = UT_Array<NET_NetworkCookie>

Definition at line 101 of file NET_NetworkCookieStore.h.

using NET_NetworkCookieStore::iterator = CookieList::iterator

Definition at line 102 of file NET_NetworkCookieStore.h.

Member Enumeration Documentation

enum NET_NetworkCookieStore::StoragePolicy
Enumerator
NoPersistentCookies 
AllowPersistentCookies 
ForcePersistentCookies 

Definition at line 105 of file NET_NetworkCookieStore.h.

Constructor & Destructor Documentation

NET_NetworkCookieStore::NET_NetworkCookieStore ( const PrivateCtorTag &  ,
const ASIO_AnyExecutor &  exc 
)
inline

Definition at line 152 of file NET_NetworkCookieStore.h.

NET_NetworkCookieStore::~NET_NetworkCookieStore ( )

Member Function Documentation

CookieList NET_NetworkCookieStore::allCookies ( ) const
void NET_NetworkCookieStore::attachObserver ( const UT_SharedPtr< NET_INetworkCookieStoreObserver > &  observer)
void NET_NetworkCookieStore::configure ( const UT_StringHolder &  storage,
StoragePolicy  policy 
)
CookieList NET_NetworkCookieStore::cookiesForUrl ( const UT_Url &  url) const
template<typename ExecutionContext , typename = typename std::enable_if_t<std::is_convertible_v< ExecutionContext &, hboost::asio::execution_context &>>>
static UT_SharedPtr<NET_NetworkCookieStore> NET_NetworkCookieStore::create ( ExecutionContext &  ctx,
const UT_StringHolder &  filename,
StoragePolicy  policy 
)
inlinestatic

Definition at line 166 of file NET_NetworkCookieStore.h.

static UT_SharedPtr<NET_NetworkCookieStore> NET_NetworkCookieStore::create ( const ASIO_AnyExecutor &  exc,
const UT_StringHolder &  filename,
StoragePolicy  policy 
)
inlinestatic

Definition at line 173 of file NET_NetworkCookieStore.h.

template<typename ExecutionContext , typename = typename std::enable_if_t<std::is_convertible_v< ExecutionContext &, hboost::asio::execution_context &>>>
static UT_SharedPtr<NET_NetworkCookieStore> NET_NetworkCookieStore::create ( ExecutionContext &  ctx)
inlinestatic

Definition at line 188 of file NET_NetworkCookieStore.h.

static UT_SharedPtr<NET_NetworkCookieStore> NET_NetworkCookieStore::create ( const ASIO_AnyExecutor &  exc)
inlinestatic

Definition at line 193 of file NET_NetworkCookieStore.h.

void NET_NetworkCookieStore::debugPrintStore ( ) const
void NET_NetworkCookieStore::deleteAllCookies ( )
bool NET_NetworkCookieStore::deleteCookie ( const NET_NetworkCookie &  cookie)
void NET_NetworkCookieStore::detachObserver ( const UT_SharedPtr< NET_INetworkCookieStoreObserver > &  observer)
bool NET_NetworkCookieStore::filter ( NET_CookieList &  cookies,
const UT_StringRef &  name 
) const
UT_Optional<NET_NetworkCookie> NET_NetworkCookieStore::find ( const NET_NetworkCookie &  cookie) const

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

bool NET_NetworkCookieStore::flush ( )
bool NET_NetworkCookieStore::insertCookie ( const NET_NetworkCookie &  cookie)
bool NET_NetworkCookieStore::load ( )
void NET_NetworkCookieStore::notifyInsert_ ( const NET_NetworkCookie &  cookie)
bool NET_NetworkCookieStore::setCookiesFromUrl ( const CookieList &  cookies,
const UT_Url &  url 
)
void NET_NetworkCookieStore::setStoragePolicy ( StoragePolicy  policy)
void NET_NetworkCookieStore::shutdown ( )
bool NET_NetworkCookieStore::updateCookie ( const NET_NetworkCookie &  cookie)
bool NET_NetworkCookieStore::updateCookieAccess ( const NET_NetworkCookie &  cookie)
NET_NetworkCookieStore::UT_NON_COPYABLE ( NET_NetworkCookieStore  )
The documentation for this class was generated from the following file: