Represents a value of the 'Cache-Control' header. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include <cache_control_header_value.h>

Inherits System::ICloneable.

Public Member Functions
bool	get_NoCache ()
	Gets the value that determines if the client will accept a cached response. More...

void	set_NoCache (bool value)
	Sets the value that determines if the client will accept a cached response. More...

System::SharedPtr< Collections::Generic::ICollection< String > >	get_NoCacheHeaders ()
	Gets the collection of fieldnames in the 'no-cache' directive in the 'Cache-Control' header. More...

bool	get_NoStore ()
	Gets the value that determines if a cache must not store any part of an HTTP request or response. More...

void	set_NoStore (bool value)
	Sets the value that determines if a cache must not store any part of an HTTP request or response. More...

Nullable< TimeSpan >	get_MaxAge ()
	Gets the maximum age value in seconds that determines a time during which the client will accept a response. More...

void	set_MaxAge (Nullable< TimeSpan > value)
	Sets the maximum age value in seconds that determines a time during which the client will accept a response. More...

Nullable< TimeSpan >	get_SharedMaxAge ()
	Gets the shared maximum age value in seconds that overrides the 'max-age' directive in the 'Cache-Control'. header or the 'Expires' header for a shared cache. More...

void	set_SharedMaxAge (Nullable< TimeSpan > value)
	Sets the shared maximum age value in seconds that overrides the 'max-age' directive in the 'Cache-Control'. header or the 'Expires' header for a shared cache. More...

bool	get_MaxStale ()
	Gets the value that determines if the client will accept the expired responses. More...

void	set_MaxStale (bool value)
	Sets the value that determines if the client will accept the expired responses. More...

Nullable< TimeSpan >	get_MaxStaleLimit ()
	Gets the value in seconds that determines the time during which the client will accept the expired responses. More...

void	set_MaxStaleLimit (Nullable< TimeSpan > value)
	Sets the value in seconds that determines the time during which the client will accept the expired responses. More...

Nullable< TimeSpan >	get_MinFresh ()
	Gets the value that determines the freshness lifetime. More...

void	set_MinFresh (Nullable< TimeSpan > value)
	Sets the value that determines the freshness lifetime. More...

bool	get_NoTransform ()
	Gets the value that determines if a cache or proxy must not change any part of the entity body. More...

void	set_NoTransform (bool value)
	Sets the value that determines if a cache or proxy must not change any part of the entity body. More...

bool	get_OnlyIfCached ()
	Gets the value that determines if the client must use only cached entries. More...

void	set_OnlyIfCached (bool value)
	Sets the value that determines if the client must use only cached entries. More...

bool	get_Public ()
	Gets the value that determines if an HTTP response can be cached by any cache. More...

void	set_Public (bool value)
	Sets the value that determines if an HTTP response can be cached by any cache. More...

bool	get_Private ()
	Gets the value that determines if the HTTP response message or its part is intended for a single user and must not be cached by a shared cache. More...

void	set_Private (bool value)
	Sets the value that determines if the HTTP response message or its part is intended for a single user and must not be cached by a shared cache. More...

System::SharedPtr< Collections::Generic::ICollection< String > >	get_PrivateHeaders ()
	Gets the collection of fieldnames in the 'private' directive in the 'Cache-Control' header. More...

bool	get_MustRevalidate ()
	Gets the value that determines if the server requires revalidation of a cache entry when the it becomes stale. More...

void	set_MustRevalidate (bool value)
	Sets the value that determines if the server requires revalidation of a cache entry when the it becomes stale. More...

bool	get_ProxyRevalidate ()
	Gets the value that determines if the server requires revalidation of a cache entry when it becomes stale for the shared user agent caches. More...

void	set_ProxyRevalidate (bool value)
	Sets the value that determines if the server requires revalidation of a cache entry when it becomes stale for the shared user agent caches. More...

System::SharedPtr< Collections::Generic::ICollection< System::SharedPtr< NameValueHeaderValue > > >	get_Extensions ()
	Returns the collection of the cache-extension tokens. More...

	CacheControlHeaderValue ()
	Constructs a new instance. More...

String	ToString () const override
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

bool	Equals (System::SharedPtr< Object > obj) override
	Compares objects using C# Object.Equals semantics. More...

int32_t	GetHashCode () const override
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual System::SharedPtr< System::Object >	Clone ()=0
	Creates a copy of the current object and returns a shared pointer to it. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Static Public Member Functions
static System::SharedPtr< CacheControlHeaderValue >	Parse (String input)
	Converts a passed string to an instance of the CacheControlHeaderValue class. More...

static bool	TryParse (String input, System::SharedPtr< CacheControlHeaderValue > &parsedValue)
	Tries to convert a passed string to an instance of the CacheControlHeaderValue class. More...

static int32_t	GetCacheControlLength (String input, int32_t startIndex, System::SharedPtr< CacheControlHeaderValue > storeValue, System::SharedPtr< CacheControlHeaderValue > &parsedValue)
	Converts a passed string from the specified index to an instance of the CacheControlHeaderValue class. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Detailed Description

Represents a value of the 'Cache-Control' header. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ CacheControlHeaderValue()

System::Net::Http::Headers::CacheControlHeaderValue::CacheControlHeaderValue ( )

Constructs a new instance.

Member Function Documentation

◆ Equals()

bool System::Net::Http::Headers::CacheControlHeaderValue::Equals ( System::SharedPtr< Object > obj )

override

Compares objects using C# Object.Equals semantics.

Parameters

obj	Object to compare current one to.

Returns: True if objects are considered equal and false otherwise.

◆ get_Extensions()

System::SharedPtr< Collections::Generic::ICollection< System::SharedPtr< NameValueHeaderValue > > > System::Net::Http::Headers::CacheControlHeaderValue::get_Extensions ( )

Returns the collection of the cache-extension tokens.

Returns: The collection of the cache-extension tokens.

◆ get_MaxAge()

Nullable< TimeSpan > System::Net::Http::Headers::CacheControlHeaderValue::get_MaxAge ( )

Gets the maximum age value in seconds that determines a time during which the client will accept a response.

Returns: The maximum age value in seconds that determines a time during which the client will accept a response.

◆ get_MaxStale()

bool System::Net::Http::Headers::CacheControlHeaderValue::get_MaxStale ( )

Gets the value that determines if the client will accept the expired responses.

Returns: The value that determines if the client will accept the expired responses.

◆ get_MaxStaleLimit()

Nullable< TimeSpan > System::Net::Http::Headers::CacheControlHeaderValue::get_MaxStaleLimit ( )

Gets the value in seconds that determines the time during which the client will accept the expired responses.

Returns: The value in seconds that determines the time during which the client will accept the expired responses.

◆ get_MinFresh()

Nullable< TimeSpan > System::Net::Http::Headers::CacheControlHeaderValue::get_MinFresh ( )

Gets the value that determines the freshness lifetime.

Returns: The value that determines the freshness lifetime.

◆ get_MustRevalidate()

bool System::Net::Http::Headers::CacheControlHeaderValue::get_MustRevalidate ( )

Gets the value that determines if the server requires revalidation of a cache entry when the it becomes stale.

Returns: The value that determines if the server requires revalidation of a cache entry when the it becomes stale.

◆ get_NoCache()

bool System::Net::Http::Headers::CacheControlHeaderValue::get_NoCache ( )

Gets the value that determines if the client will accept a cached response.

Returns: The value that determines if the client will accept a cached response.

◆ get_NoCacheHeaders()

System::SharedPtr< Collections::Generic::ICollection< String > > System::Net::Http::Headers::CacheControlHeaderValue::get_NoCacheHeaders ( )

Gets the collection of fieldnames in the 'no-cache' directive in the 'Cache-Control' header.

Returns: A collection of fieldnames in the 'no-cache' directive in the 'Cache-Control' header.

◆ get_NoStore()

bool System::Net::Http::Headers::CacheControlHeaderValue::get_NoStore ( )

Gets the value that determines if a cache must not store any part of an HTTP request or response.

Returns: The value that determines if a cache must not store any part of an HTTP request or response.

◆ get_NoTransform()

bool System::Net::Http::Headers::CacheControlHeaderValue::get_NoTransform ( )

Gets the value that determines if a cache or proxy must not change any part of the entity body.

Returns: The value that determines if a cache or proxy must not change any part of the entity body.

◆ get_OnlyIfCached()

bool System::Net::Http::Headers::CacheControlHeaderValue::get_OnlyIfCached ( )

Gets the value that determines if the client must use only cached entries.

Returns: The value that determines if the client must use only cached entries.

◆ get_Private()

bool System::Net::Http::Headers::CacheControlHeaderValue::get_Private ( )

Gets the value that determines if the HTTP response message or its part is intended for a single user and must not be cached by a shared cache.

Returns: The value that determines if the HTTP response message or its part is intended for a single user and must not be cached by a shared cache.

◆ get_PrivateHeaders()

System::SharedPtr< Collections::Generic::ICollection< String > > System::Net::Http::Headers::CacheControlHeaderValue::get_PrivateHeaders ( )

Gets the collection of fieldnames in the 'private' directive in the 'Cache-Control' header.

Returns: A collection of fieldnames in the 'private' directive in the 'Cache-Control' header.

◆ get_ProxyRevalidate()

bool System::Net::Http::Headers::CacheControlHeaderValue::get_ProxyRevalidate ( )

Gets the value that determines if the server requires revalidation of a cache entry when it becomes stale for the shared user agent caches.

Returns: The value that determines if the server requires revalidation of a cache entry when it becomes stale for the shared user agent caches.

◆ get_Public()

bool System::Net::Http::Headers::CacheControlHeaderValue::get_Public ( )

Gets the value that determines if an HTTP response can be cached by any cache.

Returns: The value that determines if an HTTP response can be cached by any cache.

◆ get_SharedMaxAge()

Nullable< TimeSpan > System::Net::Http::Headers::CacheControlHeaderValue::get_SharedMaxAge ( )

Gets the shared maximum age value in seconds that overrides the 'max-age' directive in the 'Cache-Control'. header or the 'Expires' header for a shared cache.

Returns: The shared maximum age value in seconds that overrides the 'max-age' directive in the 'Cache-Control'. header or the 'Expires' header for a shared cache.

◆ GetCacheControlLength()

static int32_t System::Net::Http::Headers::CacheControlHeaderValue::GetCacheControlLength	(	String	input,
		int32_t	startIndex,
		System::SharedPtr< CacheControlHeaderValue >	storeValue,
		System::SharedPtr< CacheControlHeaderValue > &	parsedValue
	)

static

Converts a passed string from the specified index to an instance of the CacheControlHeaderValue class.

Parameters

input	A string to parse.
startIndex	A start position for parsing.
storeValue	A value that must be added to the parsed object.
parsedValue	An instance where a parsed object will be assigned.

Returns: The length of a parsed substring, otherwise 0.

◆ GetHashCode()

int32_t System::Net::Http::Headers::CacheControlHeaderValue::GetHashCode ( ) const

overridevirtual

Analog of C# Object.GetHashCode() method. Enables hashing of custom objects.

Returns: Hash code value as calculated by corresponding class.

Reimplemented from System::Object.

◆ Parse()

static System::SharedPtr< CacheControlHeaderValue > System::Net::Http::Headers::CacheControlHeaderValue::Parse ( String input )

static

Converts a passed string to an instance of the CacheControlHeaderValue class.

Parameters

input A string to parse.

Returns: An instance of the CacheControlHeaderValue class.

◆ set_MaxAge()

void System::Net::Http::Headers::CacheControlHeaderValue::set_MaxAge ( Nullable< TimeSpan > value )

Sets the maximum age value in seconds that determines a time during which the client will accept a response.

Parameters

value The maximum age that must be set.

◆ set_MaxStale()

void System::Net::Http::Headers::CacheControlHeaderValue::set_MaxStale ( bool value )

Sets the value that determines if the client will accept the expired responses.

Parameters

value The value that must be set.

◆ set_MaxStaleLimit()

void System::Net::Http::Headers::CacheControlHeaderValue::set_MaxStaleLimit ( Nullable< TimeSpan > value )

Sets the value in seconds that determines the time during which the client will accept the expired responses.

Parameters

value The value that must be set.

◆ set_MinFresh()

void System::Net::Http::Headers::CacheControlHeaderValue::set_MinFresh ( Nullable< TimeSpan > value )

Sets the value that determines the freshness lifetime.

Parameters

value The value that must be set.

◆ set_MustRevalidate()

void System::Net::Http::Headers::CacheControlHeaderValue::set_MustRevalidate ( bool value )

Sets the value that determines if the server requires revalidation of a cache entry when the it becomes stale.

Parameters

value The value that must be set.

◆ set_NoCache()

void System::Net::Http::Headers::CacheControlHeaderValue::set_NoCache ( bool value )

Sets the value that determines if the client will accept a cached response.

Parameters

value The value that will be set.

◆ set_NoStore()

void System::Net::Http::Headers::CacheControlHeaderValue::set_NoStore ( bool value )

Sets the value that determines if a cache must not store any part of an HTTP request or response.

Parameters

value The value that will be set.

◆ set_NoTransform()

void System::Net::Http::Headers::CacheControlHeaderValue::set_NoTransform ( bool value )

Sets the value that determines if a cache or proxy must not change any part of the entity body.

Parameters

value The value that must be set.

◆ set_OnlyIfCached()

void System::Net::Http::Headers::CacheControlHeaderValue::set_OnlyIfCached ( bool value )

Sets the value that determines if the client must use only cached entries.

Parameters

value The value that must be set.

◆ set_Private()

void System::Net::Http::Headers::CacheControlHeaderValue::set_Private ( bool value )

Sets the value that determines if the HTTP response message or its part is intended for a single user and must not be cached by a shared cache.

Parameters

value The value that must be set.

◆ set_ProxyRevalidate()

void System::Net::Http::Headers::CacheControlHeaderValue::set_ProxyRevalidate ( bool value )

Sets the value that determines if the server requires revalidation of a cache entry when it becomes stale for the shared user agent caches.

Parameters

value The value that must be set.

◆ set_Public()

void System::Net::Http::Headers::CacheControlHeaderValue::set_Public ( bool value )

Sets the value that determines if an HTTP response can be cached by any cache.

Parameters

value The value that must be set.

◆ set_SharedMaxAge()

void System::Net::Http::Headers::CacheControlHeaderValue::set_SharedMaxAge ( Nullable< TimeSpan > value )

Sets the shared maximum age value in seconds that overrides the 'max-age' directive in the 'Cache-Control'. header or the 'Expires' header for a shared cache.

Parameters

value The shared maximum age that must be set.

◆ ToString()

String System::Net::Http::Headers::CacheControlHeaderValue::ToString ( ) const

overridevirtual

Analog of C# Object.ToString() method. Enables converting custom objects to string.

Returns: String representation as provided by final class.

Reimplemented from System::Object.

◆ TryParse()

static bool System::Net::Http::Headers::CacheControlHeaderValue::TryParse	(	String	input,
		System::SharedPtr< CacheControlHeaderValue > &	parsedValue
	)

static

Tries to convert a passed string to an instance of the CacheControlHeaderValue class.

Parameters

input	A string to parse.
parsedValue	An instance where a parsed object will be assigned.

Returns: True when the parsing is successfully done, otherwise false.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CacheControlHeaderValue()

Member Function Documentation

◆ Equals()

◆ get_Extensions()

◆ get_MaxAge()

◆ get_MaxStale()

◆ get_MaxStaleLimit()

◆ get_MinFresh()

◆ get_MustRevalidate()

◆ get_NoCache()

◆ get_NoCacheHeaders()

◆ get_NoStore()

◆ get_NoTransform()

◆ get_OnlyIfCached()

◆ get_Private()

◆ get_PrivateHeaders()

◆ get_ProxyRevalidate()

◆ get_Public()

◆ get_SharedMaxAge()

◆ GetCacheControlLength()

◆ GetHashCode()

◆ Parse()

◆ set_MaxAge()

◆ set_MaxStale()

◆ set_MaxStaleLimit()

◆ set_MinFresh()

◆ set_MustRevalidate()

◆ set_NoCache()

◆ set_NoStore()

◆ set_NoTransform()

◆ set_OnlyIfCached()

◆ set_Private()

◆ set_ProxyRevalidate()

◆ set_Public()

◆ set_SharedMaxAge()

◆ ToString()

◆ TryParse()