System::Web::Services::Protocols::WebClientProtocol Class Reference

Inherits System::Object.

Inherited by System::Web::Services::Protocols::HttpWebClientProtocol.

Public Member Functions

ASPOSECPP_SHARED_API System::SharedPtr< Uriget_Uri ()
 
ASPOSECPP_SHARED_API void set_Uri (System::SharedPtr< Uri > uri)
 
ASPOSECPP_SHARED_API String get_ConnectionGroupName ()
 
ASPOSECPP_SHARED_API void set_ConnectionGroupName (String value)
 
ASPOSECPP_SHARED_API System::SharedPtr< Net::ICredentialsget_Credentials ()
 
ASPOSECPP_SHARED_API void set_Credentials (System::SharedPtr< Net::ICredentials > value)
 
ASPOSECPP_SHARED_API bool get_PreAuthenticate ()
 
ASPOSECPP_SHARED_API void set_PreAuthenticate (bool value)
 
ASPOSECPP_SHARED_API System::SharedPtr< Text::Encodingget_RequestEncoding ()
 
ASPOSECPP_SHARED_API void set_RequestEncoding (System::SharedPtr< Text::Encoding > value)
 
ASPOSECPP_SHARED_API int32_t get_Timeout ()
 
ASPOSECPP_SHARED_API void set_Timeout (int32_t value)
 
ASPOSECPP_SHARED_API String get_Url ()
 
ASPOSECPP_SHARED_API void set_Url (String value)
 
ASPOSECPP_SHARED_API bool get_UseDefaultCredentials ()
 
ASPOSECPP_SHARED_API void set_UseDefaultCredentials (bool value)
 
virtual ASPOSECPP_SHARED_API void Abort ()
 Cancels the request. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API 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...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API 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 ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Public Attributes

System::SharedPtr< Uriuri
 The XML Web service URI. 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::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...
 

Detailed Description

This base class is used in all XML Web service client proxies that were created using ASP.NET. 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 Function Documentation

◆ Abort()

virtual ASPOSECPP_SHARED_API void System::Web::Services::Protocols::WebClientProtocol::Abort ( )
virtual

Cancels the request.

◆ get_ConnectionGroupName()

ASPOSECPP_SHARED_API String System::Web::Services::Protocols::WebClientProtocol::get_ConnectionGroupName ( )

Gets the name of the connection group.

Returns
The name of the connection group.

◆ get_Credentials()

ASPOSECPP_SHARED_API System::SharedPtr<Net::ICredentials> System::Web::Services::Protocols::WebClientProtocol::get_Credentials ( )

Gets the authentication information.

Returns
The authentication information.

◆ get_PreAuthenticate()

ASPOSECPP_SHARED_API bool System::Web::Services::Protocols::WebClientProtocol::get_PreAuthenticate ( )

Gets a value that indicates if pre-authentication is enabled.

Returns
A value that indicates if pre-authentication is enabled.

◆ get_RequestEncoding()

ASPOSECPP_SHARED_API System::SharedPtr<Text::Encoding> System::Web::Services::Protocols::WebClientProtocol::get_RequestEncoding ( )

Gets the encoding that is used to make the client requests.

Returns
The encoding that is used to make the client requests.

◆ get_Timeout()

ASPOSECPP_SHARED_API int32_t System::Web::Services::Protocols::WebClientProtocol::get_Timeout ( )

Gets the timespan to wait before the request times out.

Returns
The timespan to wait before the request times out.

◆ get_Uri()

ASPOSECPP_SHARED_API System::SharedPtr<Uri> System::Web::Services::Protocols::WebClientProtocol::get_Uri ( )

Gets the XML Web service URI.

Returns
The XML Web service URI.

◆ get_Url()

ASPOSECPP_SHARED_API String System::Web::Services::Protocols::WebClientProtocol::get_Url ( )

Gets the XML Web service URL.

Returns
The XML Web service URL.

◆ get_UseDefaultCredentials()

ASPOSECPP_SHARED_API bool System::Web::Services::Protocols::WebClientProtocol::get_UseDefaultCredentials ( )

Gets a value that indicates if the 'Credential' property is equal to the 'DefaultCredentials' property.

Returns
The value that indicates if the 'Credential' property is equal to the 'DefaultCredentials' property.
Exceptions
System::NotImplementedException

◆ set_ConnectionGroupName()

ASPOSECPP_SHARED_API void System::Web::Services::Protocols::WebClientProtocol::set_ConnectionGroupName ( String  value)

Sets the name of the connection group.

Parameters
valueThe value that must be set.

◆ set_Credentials()

ASPOSECPP_SHARED_API void System::Web::Services::Protocols::WebClientProtocol::set_Credentials ( System::SharedPtr< Net::ICredentials value)

Sets the authentication information.

Parameters
valueThe authentication information.

◆ set_PreAuthenticate()

ASPOSECPP_SHARED_API void System::Web::Services::Protocols::WebClientProtocol::set_PreAuthenticate ( bool  value)

Sets a value that indicates if pre-authentication is enabled.

Parameters
valueThe value that must be set.

◆ set_RequestEncoding()

ASPOSECPP_SHARED_API void System::Web::Services::Protocols::WebClientProtocol::set_RequestEncoding ( System::SharedPtr< Text::Encoding value)

Sets the encoding that is used to make the client requests.

Parameters
valueThe value that must be set.

◆ set_Timeout()

ASPOSECPP_SHARED_API void System::Web::Services::Protocols::WebClientProtocol::set_Timeout ( int32_t  value)

Sets the timespan to wait before the request times out.

Parameters
valueThe value that must be set.

◆ set_Uri()

ASPOSECPP_SHARED_API void System::Web::Services::Protocols::WebClientProtocol::set_Uri ( System::SharedPtr< Uri uri)

Sets the XML Web service URI.

Parameters
uriThe URI that must be set.

◆ set_Url()

ASPOSECPP_SHARED_API void System::Web::Services::Protocols::WebClientProtocol::set_Url ( String  value)

Sets the XML Web service URL.

Parameters
valueThe URL that must be set.

◆ set_UseDefaultCredentials()

ASPOSECPP_SHARED_API void System::Web::Services::Protocols::WebClientProtocol::set_UseDefaultCredentials ( bool  value)

Sets a value that indicates if the 'Credential' property is equal to the 'DefaultCredentials' property.

Parameters
valueThe value that must be set.
Exceptions
System::NotImplementedException

Member Data Documentation

◆ uri

System::SharedPtr<Uri> System::Web::Services::Protocols::WebClientProtocol::uri

The XML Web service URI.