Asposecpplib
System::Net::FileWebRequest Class Reference

Provides implementation of the WebRequest abstract class to work with the file system. 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::Net::WebRequest.

Public Member Functions

void set_Timeout (int timeout) override
 Sets an amount of time in milliseconds after which the request will be timed out. More...
 
String get_ContentType () override
 Gets the MIME type of the request. More...
 
void set_ContentType (String value) override
 Sets the MIME type of the request. More...
 
System::SharedPtr< WebHeaderCollectionget_Headers () override
 Gets the collection of the HTTP headers. More...
 
void set_Headers (System::SharedPtr< WebHeaderCollection > value) override
 Sets the collection of the HTTP headers. More...
 
String get_Method () override
 Gets the HTTP method. More...
 
void set_Method (String value) override
 Sets the HTTP method. More...
 
System::SharedPtr< Uriget_RequestUri () override
 Returns the request URI. More...
 
 FileWebRequest (System::SharedPtr< Uri > uri)
 Constructs a new instance. More...
 
System::SharedPtr< WebResponseGetResponse () override
 Returns the web response associated with the current web request. More...
 
void Abort () override
 Aborts the current request. More...
 
System::SharedPtr< IAsyncResultBeginGetRequestStream (AsyncCallback callback, System::SharedPtr< Object > state) override
 Initiates an asynchronous operation to get a stream for writing data to the resource. More...
 
System::SharedPtr< IO::StreamEndGetRequestStream (System::SharedPtr< IAsyncResult > asyncResult) override
 Waits until the specified asynchronous operation to get a stream completes. More...
 
System::SharedPtr< IAsyncResultBeginGetResponse (AsyncCallback callback, System::SharedPtr< Object > state) override
 Initiates an asynchronous request for the resource. More...
 
virtual System::SharedPtr< WebResponseEndGetResponse (System::SharedPtr< IAsyncResult > asyncResult) override
 Waits until the specified asynchronous request for the resource completes. More...
 
- Public Member Functions inherited from System::Net::WebRequest
virtual System::SharedPtr< ICredentialsget_Credentials ()
 Gets authentication information that is associated with the current request. More...
 
virtual void set_Credentials (System::SharedPtr< ICredentials > value)
 Sets authentication information that is associated with the current request. More...
 
virtual bool get_UseDefaultCredentials ()
 Gets a value that indicates if the 'Credential' property is equal to the 'DefaultCredentials' property. More...
 
virtual void set_UseDefaultCredentials (bool value)
 Sets a value that indicates if the 'Credential' property is equal to the 'DefaultCredentials' property. More...
 
virtual System::SharedPtr< IWebProxyget_Proxy ()
 Gets the HTTP proxy. More...
 
virtual void set_Proxy (System::SharedPtr< IWebProxy > value)
 Sets the HTTP proxy. More...
 
virtual int64_t get_ContentLength ()
 Gets the number of bytes of the request data to sent. More...
 
virtual void set_ContentLength (int64_t value)
 Sets the number of bytes of the request data to sent. More...
 
virtual System::SharedPtr< System::Net::Cache::RequestCachePolicyget_CachePolicy ()
 Gets the cache policy. More...
 
virtual void set_CachePolicy (System::SharedPtr< System::Net::Cache::RequestCachePolicy > value)
 Sets the cache policy. More...
 
virtual System::String get_ConnectionGroupName ()
 Gets the name of the connection group. More...
 
virtual void set_ConnectionGroupName (System::String value)
 Sets the name of the connection group. More...
 
virtual bool get_PreAuthenticate ()
 Gets a value that indicates if the request must be pre-authenticated. More...
 
virtual void set_PreAuthenticate (bool value)
 Sets a value that indicates if the request must be pre-authenticated. More...
 
virtual int32_t get_Timeout ()
 Gets an amount of time in milliseconds after which the request will be timed out. More...
 
virtual void set_Timeout (int32_t timeout)
 Sets an amount of time in milliseconds after which the request will be timed out. More...
 
virtual System::SharedPtr< System::IO::StreamGetRequestStream ()
 Returns the stream for writing data to the resource. 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...
 
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

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Net::WebRequest
static System::SharedPtr< Collections::Generic::List< System::SharedPtr< WebRequest::WebRequestPrefixElement > > > get_PrefixList ()
 Gets the prefix list. More...
 
static void set_PrefixList (System::SharedPtr< Collections::Generic::List< System::SharedPtr< WebRequest::WebRequestPrefixElement >>> value)
 Sets the prefix list. More...
 
static System::SharedPtr< IWebProxyget_DefaultWebProxy ()
 Gets the global HTTP proxy. More...
 
static void set_DefaultWebProxy (System::SharedPtr< IWebProxy > value)
 Sets the global HTTP proxy. More...
 
static System::SharedPtr< WebRequestCreate (String requestUriString)
 Creates a new instance of the WebRequest class using the specified URI. More...
 
static System::SharedPtr< WebRequestCreate (System::SharedPtr< Uri > requestUri)
 Creates a new instance of the WebRequest class using the specified URI. More...
 
static System::SharedPtr< WebRequestCreateDefault (System::SharedPtr< Uri > requestUri)
 Creates a WebRequest descendant for the specified URI scheme. More...
 
static System::SharedPtr< HttpWebRequestCreateHttp (String requestUriString)
 Creates a new instance of the WebRequest class using the specified URI. More...
 
static System::SharedPtr< HttpWebRequestCreateHttp (System::SharedPtr< Uri > requestUri)
 Creates a new instance of the WebRequest class using the specified URI. More...
 
static bool RegisterPrefix (String prefix, System::SharedPtr< IWebRequestCreate > creator)
 Registers the WebRequest descendant for the specified URI. 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 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::Net::WebRequest
 WebRequest ()
 Constructs a new instance. More...
 

Detailed Description

Provides implementation of the WebRequest abstract class to work with the file system. 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

◆ FileWebRequest()

System::Net::FileWebRequest::FileWebRequest ( System::SharedPtr< Uri uri)

Constructs a new instance.

Parameters
uriThe URI of the file system request.

Member Function Documentation

◆ Abort()

void System::Net::FileWebRequest::Abort ( )
overridevirtual

Aborts the current request.

Implements System::Net::WebRequest.

◆ BeginGetRequestStream()

System::SharedPtr<IAsyncResult> System::Net::FileWebRequest::BeginGetRequestStream ( AsyncCallback  callback,
System::SharedPtr< Object state 
)
overridevirtual

Initiates an asynchronous operation to get a stream for writing data to the resource.

Parameters
callbackA callback to be called when the operation completes.
stateUser-provided data used to uniquely identify each asynchronous operation.
Returns
An IAsyncResult object representing the initiated asynchronous operation.

Implements System::Net::WebRequest.

◆ BeginGetResponse()

System::SharedPtr<IAsyncResult> System::Net::FileWebRequest::BeginGetResponse ( AsyncCallback  callback,
System::SharedPtr< Object state 
)
overridevirtual

Initiates an asynchronous request for the resource.

Parameters
callbackA callback to be called when the operation completes.
stateUser-provided data used to uniquely identify each asynchronous operation.
Returns
An IAsyncResult object representing the initiated asynchronous operation.

Implements System::Net::WebRequest.

◆ EndGetRequestStream()

System::SharedPtr<IO::Stream> System::Net::FileWebRequest::EndGetRequestStream ( System::SharedPtr< IAsyncResult asyncResult)
overridevirtual

Waits until the specified asynchronous operation to get a stream completes.

Parameters
asyncResultAn IAsyncResult object that represents an asynchronous operation to get a stream.
Returns
The stream for writing data to the resource.

Implements System::Net::WebRequest.

◆ EndGetResponse()

virtual System::SharedPtr<WebResponse> System::Net::FileWebRequest::EndGetResponse ( System::SharedPtr< IAsyncResult asyncResult)
overridevirtual

Waits until the specified asynchronous request for the resource completes.

Parameters
asyncResultAn IAsyncResult object that represents an asynchronous request for the resource.
Returns
The web response.

Implements System::Net::WebRequest.

◆ get_ContentType()

String System::Net::FileWebRequest::get_ContentType ( )
overridevirtual

Gets the MIME type of the request.

Returns
The MIME type of the request.

Implements System::Net::WebRequest.

◆ get_Headers()

System::SharedPtr<WebHeaderCollection> System::Net::FileWebRequest::get_Headers ( )
overridevirtual

Gets the collection of the HTTP headers.

Returns
The collection of the HTTP headers.

Implements System::Net::WebRequest.

◆ get_Method()

String System::Net::FileWebRequest::get_Method ( )
overridevirtual

Gets the HTTP method.

Returns
The HTTP method.

Implements System::Net::WebRequest.

◆ get_RequestUri()

System::SharedPtr<Uri> System::Net::FileWebRequest::get_RequestUri ( )
overridevirtual

Returns the request URI.

Returns
The request URI.

Implements System::Net::WebRequest.

◆ GetResponse()

System::SharedPtr<WebResponse> System::Net::FileWebRequest::GetResponse ( )
overridevirtual

Returns the web response associated with the current web request.

Returns
The web response associated with the current web request.

Reimplemented from System::Net::WebRequest.

◆ set_ContentType()

void System::Net::FileWebRequest::set_ContentType ( String  value)
overridevirtual

Sets the MIME type of the request.

Parameters
valueThe MIME type to set.

Implements System::Net::WebRequest.

◆ set_Headers()

void System::Net::FileWebRequest::set_Headers ( System::SharedPtr< WebHeaderCollection value)
overridevirtual

Sets the collection of the HTTP headers.

Parameters
valueThe collection of the HTTP headers to set.

Implements System::Net::WebRequest.

◆ set_Method()

void System::Net::FileWebRequest::set_Method ( String  value)
overridevirtual

Sets the HTTP method.

Parameters
valueThe HTTP method to set.

Implements System::Net::WebRequest.

◆ set_Timeout()

void System::Net::FileWebRequest::set_Timeout ( int  timeout)
override

Sets an amount of time in milliseconds after which the request will be timed out.

Parameters
timeoutA timeout to set.