Represents a base class of an HTTP client for sending requests and receiving responses. 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 <http_client.h>

Inherits System::Net::Http::HttpMessageInvoker.

Public Member Functions
System::SharedPtr< Headers::HttpRequestHeaders >	get_DefaultRequestHeaders ()
	Gets the headers sent with each request. More...

System::SharedPtr< Uri >	get_BaseAddress ()
	Gets the base address of the resource that is used for sending requests. More...

void	set_BaseAddress (System::SharedPtr< Uri > value)
	Sets the base address of the resource that is used for sending requests. More...

TimeSpan	get_Timeout ()
	Gets the timespan to wait before the request times out. More...

void	set_Timeout (TimeSpan value)
	Sets the timespan to wait before the request times out. More...

int64_t	get_MaxResponseContentBufferSize ()
	Gets the maximum number of bytes of response content. More...

void	set_MaxResponseContentBufferSize (int64_t value)
	Sets the maximum number of bytes of response content. More...

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

	HttpClient (System::SharedPtr< HttpMessageHandler > handler)
	Constructs a new instance. More...

	HttpClient (System::SharedPtr< HttpMessageHandler > handler, bool disposeHandler)
	Constructs a new instance. More...

void	CancelPendingRequests ()
	Cancels all pending requests. More...

System::SharedPtr< HttpResponseMessage >	Send (System::SharedPtr< HttpRequestMessage > request, HttpCompletionOption completionOption)
	Sends the specified HTTP request. More...

Public Member Functions inherited from System::Net::Http::HttpMessageInvoker
	HttpMessageInvoker (System::SharedPtr< HttpMessageHandler > handler)
	Constructs a new instance. More...

	HttpMessageInvoker (System::SharedPtr< HttpMessageHandler > handler, bool disposeHandler)
	Constructs a new instance. More...

virtual System::SharedPtr< HttpResponseMessage >	Send (System::SharedPtr< HttpRequestMessage > request)
	Sends the specified request. More...

void	Dispose () override
	Disposes the current instance. This method also disposes the handler if required. More...

virtual void	Dispose ()
	Does nothing. 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...

Protected Member Functions
void	Dispose (bool disposing) override
	Disposes the current instance. This method also disposes the handler if required. More...

virtual void	Dispose (bool disposing)
	Disposes the current instance. This method also disposes the handler if required. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. 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...

Detailed Description

Represents a base class of an HTTP client for sending requests and receiving responses. 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

◆ HttpClient() [1/3]

System::Net::Http::HttpClient::HttpClient ( )

Constructs a new instance.

◆ HttpClient() [2/3]

System::Net::Http::HttpClient::HttpClient ( System::SharedPtr< HttpMessageHandler > handler )

Constructs a new instance.

Parameters

handler The HTTP handler used for sending requests.

◆ HttpClient() [3/3]

System::Net::Http::HttpClient::HttpClient	(	System::SharedPtr< HttpMessageHandler >	handler,
		bool	disposeHandler
	)

Constructs a new instance.

Parameters

handler	The HTTP handler used for sending requests.
disposeHandler	The value that indicates if the handler must be disposed when this instance is disposed.

Member Function Documentation

◆ CancelPendingRequests()

void System::Net::Http::HttpClient::CancelPendingRequests ( )

Cancels all pending requests.

◆ Dispose()

void System::Net::Http::HttpClient::Dispose ( bool disposing )

overrideprotectedvirtual

Disposes the current instance. This method also disposes the handler if required.

Reimplemented from System::Net::Http::HttpMessageInvoker.

◆ get_BaseAddress()

System::SharedPtr< Uri > System::Net::Http::HttpClient::get_BaseAddress ( )

Gets the base address of the resource that is used for sending requests.

Returns: The base address of the resource that is used for sending requests.

◆ get_DefaultRequestHeaders()

System::SharedPtr< Headers::HttpRequestHeaders > System::Net::Http::HttpClient::get_DefaultRequestHeaders ( )

Gets the headers sent with each request.

Returns: The headers sent with each request.

◆ get_MaxResponseContentBufferSize()

int64_t System::Net::Http::HttpClient::get_MaxResponseContentBufferSize ( )

Gets the maximum number of bytes of response content.

Returns: The maximum number of bytes of response content.

◆ get_Timeout()

TimeSpan System::Net::Http::HttpClient::get_Timeout ( )

Gets the timespan to wait before the request times out.

Returns: The timespan to wait before the request times out.

◆ Send()

System::SharedPtr< HttpResponseMessage > System::Net::Http::HttpClient::Send	(	System::SharedPtr< HttpRequestMessage >	request,
		HttpCompletionOption	completionOption
	)

Sends the specified HTTP request.

Parameters

request	The HTTP request that must be sent.
completionOption	The value that indicates when to complete the operation.

◆ set_BaseAddress()

void System::Net::Http::HttpClient::set_BaseAddress ( System::SharedPtr< Uri > value )

Sets the base address of the resource that is used for sending requests.

Parameters

value The value that will be set.

◆ set_MaxResponseContentBufferSize()

void System::Net::Http::HttpClient::set_MaxResponseContentBufferSize ( int64_t value )

Sets the maximum number of bytes of response content.

Parameters

value The value that will be set.

◆ set_Timeout()

void System::Net::Http::HttpClient::set_Timeout ( TimeSpan value )

Sets the timespan to wait before the request times out.

Parameters

value The value that will be set.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HttpClient() [1/3]

◆ HttpClient() [2/3]

◆ HttpClient() [3/3]

Member Function Documentation

◆ CancelPendingRequests()

◆ Dispose()

◆ get_BaseAddress()

◆ get_DefaultRequestHeaders()

◆ get_MaxResponseContentBufferSize()

◆ get_Timeout()

◆ Send()

◆ set_BaseAddress()

◆ set_MaxResponseContentBufferSize()

◆ set_Timeout()