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

#include <NET_NetworkCookie.h>

Public Types

enum  StringForm { NameAndValueOnly, Full }
 
enum  SameSite { SAME_SITE_NONE, SAME_SITE_LAX, SAME_SITE_STRICT }
 

Public Member Functions

 NET_NetworkCookie ()
 
 NET_NetworkCookie (const UT_StringRef &name, const UT_StringRef &value)
 
 NET_NetworkCookie (const NET_NetworkCookie &cookie)=default
 
NET_NetworkCookie & operator= (const NET_NetworkCookie &cookie)=default
 
 NET_NetworkCookie (NET_NetworkCookie &&cookie)=default
 
NET_NetworkCookie & operator= (NET_NetworkCookie &&cookie)=default
 
bool operator== (const NET_NetworkCookie &cookie) const
 
bool operator!= (const NET_NetworkCookie &cookie) const
 
bool hasSameIdentifier (const NET_NetworkCookie &cookie) const
 
UT_StringHolder toString (StringForm form=Full) const
 
bool hasMatchingDomain (const NET_NetworkCookie &cookie) const
 
bool hasMatchingDomain (const UT_Url &url) const
 
bool hasMatchingPath (const UT_StringRef &path) const
 
bool hasMatchingPath (const UT_Url &url) const
 
bool hasMatchingPath (const NET_NetworkCookie &cookie) const
 
bool isEquivalent (const NET_NetworkCookie &cookie) const
 
bool isValid () const
 
bool hasExpired () const
 
void normalize (const UT_Url &url)
 
bool parseCookie (const UT_StringRef &cookie)
 
const UT_StringHolder & name () const
 
const UT_StringHolder & domain () const
 
const NET_Time & creation () const
 
const NET_Time & expiration () const
 
const UT_StringHolder & path () const
 
const UT_StringHolder & value () const
 
bool isHttpOnly () const
 
bool isSecure () const
 
const NET_Time & lastAccess () const
 
bool isPersistent () const
 
int maxAge () const
 
SameSite sameSite () const
 
void setName (const UT_StringHolder &name)
 
void setDomain (const UT_StringHolder &domain)
 
void setCreation (const NET_Time &t)
 
void setExpiration (const NET_Time &t)
 
bool setExpiration (const UT_StringRef &date)
 
void setPath (const UT_StringHolder &path)
 
void setValue (const UT_StringHolder &value)
 
void setHttpOnly (bool http_only)
 
void setSecure (bool is_secure)
 
void setLastAccess (const NET_Time &t)
 
void setPersistent (bool is_persistent)
 
void setMaxAge (int max_age)
 
void setSameSite (SameSite same_site)
 
void dump () const
 

Static Public Member Functions

static void parseCookies (const UT_StringArray &cookie_string, NET_CookieList &cookies)
 

Friends

class NET_NetworkCookieStore
 

Detailed Description

Definition at line 29 of file NET_NetworkCookie.h.

Member Enumeration Documentation

enum NET_NetworkCookie::SameSite
Enumerator
SAME_SITE_NONE 
SAME_SITE_LAX 
SAME_SITE_STRICT 

Definition at line 38 of file NET_NetworkCookie.h.

enum NET_NetworkCookie::StringForm
Enumerator
NameAndValueOnly 
Full 

Definition at line 32 of file NET_NetworkCookie.h.

Constructor & Destructor Documentation

NET_NetworkCookie::NET_NetworkCookie ( )
NET_NetworkCookie::NET_NetworkCookie ( const UT_StringRef &  name,
const UT_StringRef &  value 
)
NET_NetworkCookie::NET_NetworkCookie ( const NET_NetworkCookie &  cookie)
default
NET_NetworkCookie::NET_NetworkCookie ( NET_NetworkCookie &&  cookie)
default

Member Function Documentation

const NET_Time& NET_NetworkCookie::creation ( ) const
inline

Definition at line 81 of file NET_NetworkCookie.h.

const UT_StringHolder& NET_NetworkCookie::domain ( ) const
inline

Definition at line 80 of file NET_NetworkCookie.h.

void NET_NetworkCookie::dump ( ) const
const NET_Time& NET_NetworkCookie::expiration ( ) const
inline

Definition at line 82 of file NET_NetworkCookie.h.

bool NET_NetworkCookie::hasExpired ( ) const
bool NET_NetworkCookie::hasMatchingDomain ( const NET_NetworkCookie &  cookie) const
bool NET_NetworkCookie::hasMatchingDomain ( const UT_Url &  url) const
bool NET_NetworkCookie::hasMatchingPath ( const UT_StringRef &  path) const
bool NET_NetworkCookie::hasMatchingPath ( const UT_Url &  url) const
bool NET_NetworkCookie::hasMatchingPath ( const NET_NetworkCookie &  cookie) const
bool NET_NetworkCookie::hasSameIdentifier ( const NET_NetworkCookie &  cookie) const
bool NET_NetworkCookie::isEquivalent ( const NET_NetworkCookie &  cookie) const
inline

Definition at line 64 of file NET_NetworkCookie.h.

bool NET_NetworkCookie::isHttpOnly ( ) const
inline

Definition at line 85 of file NET_NetworkCookie.h.

bool NET_NetworkCookie::isPersistent ( ) const
inline

Definition at line 88 of file NET_NetworkCookie.h.

bool NET_NetworkCookie::isSecure ( ) const
inline

Definition at line 86 of file NET_NetworkCookie.h.

bool NET_NetworkCookie::isValid ( ) const
const NET_Time& NET_NetworkCookie::lastAccess ( ) const
inline

Definition at line 87 of file NET_NetworkCookie.h.

int NET_NetworkCookie::maxAge ( ) const
inline

Definition at line 89 of file NET_NetworkCookie.h.

const UT_StringHolder& NET_NetworkCookie::name ( ) const
inline

Definition at line 79 of file NET_NetworkCookie.h.

void NET_NetworkCookie::normalize ( const UT_Url &  url)
bool NET_NetworkCookie::operator!= ( const NET_NetworkCookie &  cookie) const
inline

Definition at line 154 of file NET_NetworkCookie.h.

NET_NetworkCookie& NET_NetworkCookie::operator= ( const NET_NetworkCookie &  cookie)
default
NET_NetworkCookie& NET_NetworkCookie::operator= ( NET_NetworkCookie &&  cookie)
default
bool NET_NetworkCookie::operator== ( const NET_NetworkCookie &  cookie) const
inline

Definition at line 142 of file NET_NetworkCookie.h.

bool NET_NetworkCookie::parseCookie ( const UT_StringRef &  cookie)
static void NET_NetworkCookie::parseCookies ( const UT_StringArray &  cookie_string,
NET_CookieList &  cookies 
)
static
const UT_StringHolder& NET_NetworkCookie::path ( ) const
inline

Definition at line 83 of file NET_NetworkCookie.h.

SameSite NET_NetworkCookie::sameSite ( ) const
inline

Definition at line 90 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setCreation ( const NET_Time &  t)
inline

Definition at line 94 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setDomain ( const UT_StringHolder &  domain)
inline

Definition at line 93 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setExpiration ( const NET_Time &  t)
inline

Definition at line 95 of file NET_NetworkCookie.h.

bool NET_NetworkCookie::setExpiration ( const UT_StringRef &  date)
inline

Definition at line 101 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setHttpOnly ( bool  http_only)
inline

Definition at line 111 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setLastAccess ( const NET_Time &  t)
inline

Definition at line 113 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setMaxAge ( int  max_age)
inline

Definition at line 115 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setName ( const UT_StringHolder &  name)
inline

Definition at line 92 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setPath ( const UT_StringHolder &  path)
inline

Definition at line 109 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setPersistent ( bool  is_persistent)
inline

Definition at line 114 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setSameSite ( SameSite  same_site)
inline

Definition at line 116 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setSecure ( bool  is_secure)
inline

Definition at line 112 of file NET_NetworkCookie.h.

void NET_NetworkCookie::setValue ( const UT_StringHolder &  value)
inline

Definition at line 110 of file NET_NetworkCookie.h.

UT_StringHolder NET_NetworkCookie::toString ( StringForm  form = Full) const
const UT_StringHolder& NET_NetworkCookie::value ( ) const
inline

Definition at line 84 of file NET_NetworkCookie.h.

Friends And Related Function Documentation

friend class NET_NetworkCookieStore
friend

Definition at line 121 of file NET_NetworkCookie.h.

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