Asposecpplib
System::Net::CookieCollection Class Reference

Represents a list of sorted cookies. 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...

Inherits System::Collections::Generic::ICollection< System::SharedPtr< System::Net::Cookie > >.

Public Types

enum class  Stamp { Check = 0 , Set = 1 , SetToUnused = 2 , SetToMaxUsed = 3 }
 Enumerates the timestamp set operations. More...
 
- Public Types inherited from System::Collections::Generic::ICollection< System::SharedPtr< System::Net::Cookie > >
typedef System::SharedPtr< System::Net::CookieValueType
 Value type name. More...
 
typedef ICollection< System::SharedPtr< System::Net::Cookie > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< T >
typedef IEnumerator< T > IEnumeratorType
 Enumerator type. More...
 
using ValueType = T
 
using iterator = EnumeratorBasedIterator< T, IEnumerator< T > >
 
using const_iterator = iterator
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

int32_t get_Count () const override
 Gets number of elements in collection. More...
 
bool get_IsOtherVersionSeen ()
 Returns a value that indicates if the collection contains a cookie with a version that is not equal to Cookie::MaxSupportedVersion. More...
 
 CookieCollection ()
 Constructs a new instance. More...
 
System::SharedPtr< Cookieidx_get (int32_t index)
 Returns a cookie from the cookie collection at the specified index. More...
 
System::SharedPtr< Cookieidx_get (String name)
 Returns a cookie from the cookie collection by specified name. More...
 
void Add (const System::SharedPtr< Cookie > &cookie) override
 Adds a cookie to the collection. More...
 
bool Remove (const System::SharedPtr< Cookie > &cookie) override
 Removes the specified cookie from the collection. More...
 
bool Contains (const System::SharedPtr< Cookie > &cookie) const override
 Checks if the collection contains the specified cookie. More...
 
void Clear () override
 Removes all cookies from the collection. More...
 
void Add (System::SharedPtr< CookieCollection > cookies)
 Adds cookies from the specified collection to the current one. More...
 
DateTime TimeStamp (CookieCollection::Stamp how)
 Updates the timestamp by specified scenario and returns a new value. More...
 
int32_t InternalAdd (System::SharedPtr< Cookie > cookie, bool isStrict)
 Adds the specified cookie to the collection. More...
 
int32_t IndexOf (System::SharedPtr< Cookie > cookie)
 Returns an index of the specified cookie. More...
 
void RemoveAt (int32_t idx)
 Removes a cookie at the specified index. More...
 
System::SharedPtr< Collections::Generic::IEnumerator< System::SharedPtr< Cookie > > > GetEnumerator () override
 Gets enumerator. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< System::Net::Cookie > >
virtual bool get_IsReadOnly () const
 Checks if collection is read only. More...
 
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< System::Net::Cookie > > array, int arrayIndex)=0
 Copies all collection elements to existing array elements. More...
 
ICollectionoperator= (ICollection &&)
 Move assignment operator. More...
 
ICollectionoperator= (const ICollection &)
 Move assignment operator. More...
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&)
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< T >
LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
LINQ_First ()
 Returns the first element of a sequence. More...
 
LINQ_First (const Func< T, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
LINQ_Last ()
 Returns the last element of a sequence. More...
 
LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< T > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< T, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< T > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(T)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(T)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (T value)
 Determines if a sequence contains a specified value. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderBy (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
template<typename Key >
SharedPtr< IEnumerable< T > > LINQ_OrderByDescending (const Func< T, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 Transforms elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< T > > LINQ_Concat (SharedPtr< IEnumerable< T >> sequence)
 Concatenates two sequences. More...
 
template<typename Key >
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, T > > > > LINQ_GroupBy (System::Func< T, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
template<typename ResultType >
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< T, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
template<typename Key >
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
template<typename Result >
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
- 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...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 TypeInfoGetType () 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...
 

Additional Inherited Members

- 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 TypeInfoType ()
 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...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< T >
 ~IEnumerable () override
 Destructor. More...
 

Detailed Description

Represents a list of sorted cookies. 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.

Member Enumeration Documentation

◆ Stamp

Enumerates the timestamp set operations.

Enumerator
Check 

Do nothing.

Set 

Set the current datetime.

SetToUnused 

Set the minimal value.

SetToMaxUsed 

Set the maximum value.

Constructor & Destructor Documentation

◆ CookieCollection()

System::Net::CookieCollection::CookieCollection ( )

Constructs a new instance.

Member Function Documentation

◆ Add() [1/2]

void System::Net::CookieCollection::Add ( const System::SharedPtr< Cookie > &  cookie)
overridevirtual

Adds a cookie to the collection.

Parameters
cookieThe cookie to add.

Implements System::Collections::Generic::ICollection< System::SharedPtr< System::Net::Cookie > >.

◆ Add() [2/2]

void System::Net::CookieCollection::Add ( System::SharedPtr< CookieCollection cookies)

Adds cookies from the specified collection to the current one.

Parameters
cookiesThe collection from which cookies will be copied to the current one.

◆ Clear()

void System::Net::CookieCollection::Clear ( )
overridevirtual

◆ Contains()

bool System::Net::CookieCollection::Contains ( const System::SharedPtr< Cookie > &  cookie) const
overridevirtual

Checks if the collection contains the specified cookie.

Parameters
cookieThe cookie to check.
Returns
True when the collection contains the specified cookie, otherwise false.

Implements System::Collections::Generic::ICollection< System::SharedPtr< System::Net::Cookie > >.

◆ get_Count()

int32_t System::Net::CookieCollection::get_Count ( ) const
overridevirtual

Gets number of elements in collection.

Returns
Number of elements.

Implements System::Collections::Generic::ICollection< System::SharedPtr< System::Net::Cookie > >.

◆ get_IsOtherVersionSeen()

bool System::Net::CookieCollection::get_IsOtherVersionSeen ( )

Returns a value that indicates if the collection contains a cookie with a version that is not equal to Cookie::MaxSupportedVersion.

Returns
True when the collection contains a cookie with a version that is not equal to Cookie::MaxSupportedVersion, otherwise false.

◆ GetEnumerator()

System::SharedPtr<Collections::Generic::IEnumerator<System::SharedPtr<Cookie> > > System::Net::CookieCollection::GetEnumerator ( )
overridevirtual

Gets enumerator.

Returns
Pointer to newly created enumerator object which can be used to iterate through interfaced object.

Implements System::Collections::Generic::IEnumerable< T >.

◆ idx_get() [1/2]

System::SharedPtr<Cookie> System::Net::CookieCollection::idx_get ( int32_t  index)

Returns a cookie from the cookie collection at the specified index.

Parameters
indexThe index of a cookie that must be returned.
Returns
A cookie at the specified index.

◆ idx_get() [2/2]

System::SharedPtr<Cookie> System::Net::CookieCollection::idx_get ( String  name)

Returns a cookie from the cookie collection by specified name.

Parameters
nameThe name of a cookie that must be returned.
Returns
A cookie from the cookie collection by specified name when it is found, otherwise nullptr.

◆ IndexOf()

int32_t System::Net::CookieCollection::IndexOf ( System::SharedPtr< Cookie cookie)

Returns an index of the specified cookie.

Parameters
cookieThe cookie to search for.
Returns
An index of the specified cookie if it's found, otherwise -1.

◆ InternalAdd()

int32_t System::Net::CookieCollection::InternalAdd ( System::SharedPtr< Cookie cookie,
bool  isStrict 
)

Adds the specified cookie to the collection.

Parameters
cookieThe cookie to add.
isStrictTrue when the specified cookie must replace the old one, otherwise false.
Returns
0 when the specified cookie replaced the old one, otherwise 1.

◆ Remove()

bool System::Net::CookieCollection::Remove ( const System::SharedPtr< Cookie > &  cookie)
overridevirtual

Removes the specified cookie from the collection.

Parameters
cookieThe cookie to remove.
Returns
True when the specified cookie is removed successfully, otherwise false.
Exceptions
System::NotImplementedException

Implements System::Collections::Generic::ICollection< System::SharedPtr< System::Net::Cookie > >.

◆ RemoveAt()

void System::Net::CookieCollection::RemoveAt ( int32_t  idx)

Removes a cookie at the specified index.

Parameters
idxAn index of a cookie that must be removed.

◆ TimeStamp()

DateTime System::Net::CookieCollection::TimeStamp ( CookieCollection::Stamp  how)

Updates the timestamp by specified scenario and returns a new value.

Parameters
howThe update scenario.
Returns
A new timestamp value.