SoapHttpClientProtocol Class

 

Specifies the class client that proxies derive from when using SOAP.

Namespace:   System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Web.Services.Protocols.WebClientProtocol
        System.Web.Services.Protocols.HttpWebClientProtocol
          System.Web.Services.Protocols.SoapHttpClientProtocol

[ComVisibleAttribute(true)]
public class SoapHttpClientProtocol : HttpWebClientProtocol

NameDescription
System_CAPS_pubmethodSoapHttpClientProtocol()

Initializes a new instance of the SoapHttpClientProtocol class.

NameDescription
System_CAPS_pubpropertyAllowAutoRedirect

Gets or sets whether the client automatically follows server redirects.(Inherited from HttpWebClientProtocol.)

System_CAPS_protpropertyCanRaiseEvents

Gets a value indicating whether the component can raise an event.(Inherited from Component.)

System_CAPS_pubpropertyClientCertificates

Gets the collection of client certificates.(Inherited from HttpWebClientProtocol.)

System_CAPS_pubpropertyConnectionGroupName

Gets or sets the name of the connection group for the request.(Inherited from WebClientProtocol.)

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyCookieContainer

Gets or sets the collection of cookies.(Inherited from HttpWebClientProtocol.)

System_CAPS_pubpropertyCredentials

Gets or sets security credentials for XML Web service client authentication.(Inherited from WebClientProtocol.)

System_CAPS_protpropertyDesignMode

Gets a value that indicates whether the Component is currently in design mode.(Inherited from Component.)

System_CAPS_pubpropertyEnableDecompression

Gets or sets a value that indicates whether decompression is enabled for this HttpWebClientProtocol. (Inherited from HttpWebClientProtocol.)

System_CAPS_protpropertyEvents

Gets the list of event handlers that are attached to this Component.(Inherited from Component.)

System_CAPS_pubpropertyPreAuthenticate

Gets or sets whether pre-authentication is enabled.(Inherited from WebClientProtocol.)

System_CAPS_pubpropertyProxy

Gets or sets proxy information for making an XML Web service request through a firewall.(Inherited from HttpWebClientProtocol.)

System_CAPS_pubpropertyRequestEncoding

The Encoding used to make the client request to the XML Web service.(Inherited from WebClientProtocol.)

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_pubpropertySoapVersion

Gets or sets the version of the SOAP protocol used to make the SOAP request to the XML Web service.

System_CAPS_pubpropertyTimeout

Indicates the time an XML Web service client waits for the reply to a synchronous XML Web service request to arrive (in milliseconds).(Inherited from WebClientProtocol.)

System_CAPS_pubpropertyUnsafeAuthenticatedConnectionSharing

Gets or sets a value that indicates whether connection sharing is enabled when the client uses NTLM authentication to connect to the Web server that hosts the XML Web service.(Inherited from HttpWebClientProtocol.)

System_CAPS_pubpropertyUrl

Gets or sets the base URL of the XML Web service the client is requesting.(Inherited from WebClientProtocol.)

System_CAPS_pubpropertyUseDefaultCredentials

Gets or sets a value that indicates whether to set the Credentials property to the value of the CredentialCache.DefaultCredentials property.(Inherited from WebClientProtocol.)

System_CAPS_pubpropertyUserAgent

Gets or sets the value for the user agent header that is sent with each request.(Inherited from HttpWebClientProtocol.)

NameDescription
System_CAPS_pubmethodAbort()

Cancels a request to an XML Web service method.(Inherited from WebClientProtocol.)

System_CAPS_protmethodBeginInvoke(String, Object[], AsyncCallback, Object)

Starts an asynchronous invocation of an XML Web service method using SOAP.

System_CAPS_protmethodCancelAsync(Object)

Cancels an asynchronous call to an XML Web service method, unless the call has already completed.(Inherited from HttpWebClientProtocol.)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDiscover()

Dynamically binds to an XML Web service described in the discovery document at Url.

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_protmethodDispose(Boolean)

Releases the unmanaged resources used by the Component and optionally releases the managed resources.(Inherited from Component.)

System_CAPS_protmethodEndInvoke(IAsyncResult)

Ends an asynchronous invocation of an XML Web service method using SOAP.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection.(Inherited from Component.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodGetReaderForMessage(SoapClientMessage, Int32)

Returns an XmlReader initialized with the Stream property of the SoapClientMessage parameter.

System_CAPS_protmethodGetService(Type)

Returns an object that represents a service provided by the Component or by its Container.(Inherited from Component.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodGetWebRequest(Uri)

Creates a WebRequest for the specified uri.(Overrides HttpWebClientProtocol.GetWebRequest(Uri).)

System_CAPS_protmethodGetWebResponse(WebRequest)

Returns a response from a synchronous request to an XML Web service method.(Inherited from HttpWebClientProtocol.)

System_CAPS_protmethodGetWebResponse(WebRequest, IAsyncResult)

Returns a response from an asynchronous request to an XML Web service method.(Inherited from HttpWebClientProtocol.)

System_CAPS_protmethodGetWriterForMessage(SoapClientMessage, Int32)

Returns a XmlWriter initialized with the Stream property of the SoapClientMessage parameter.

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodInvoke(String, Object[])

Invokes an XML Web service method synchronously using SOAP.

System_CAPS_protmethodInvokeAsync(String, Object[], SendOrPostCallback)

Invokes the specified method asynchronously.

System_CAPS_protmethodInvokeAsync(String, Object[], SendOrPostCallback, Object)

Invokes the specified method asynchronously.

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone(Boolean)

Creates a shallow copy of the current MarshalByRefObject object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

NameDescription
System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

If you are building an XML Web service client, then a proxy class that derives indirectly or directly from WebClientProtocol must be created for the XML Web service. When the XML Web service client calls using SOAP, the proxy class must derive from SoapHttpClientProtocol, which derives from HttpWebClientProtocol. HttpWebClientProtocol, in turn, derives from WebClientProtocol.

To communicate with an XML Web service, create a proxy class that derives indirectly or directly from WebClientProtocol for the XML Web service you want to call. Instead of creating the proxy class manually, use the Web Services Description Language tool (Wsdl.exe) to create a proxy class for a given XML Web service's service description. When a proxy class is generated for the SOAP protocol, synchronous calls to XML Web service methods are made via the Invoke method, whereas asynchronous calls are made using the BeginInvoke method and the EndInvoke method.

Notes to Inheritors:

When you override this class, you can introduce methods in the derived class which are specific to a particular type of XML Web service. The methods capture the parameters and call the base class to do the work of communicating with the XML Web service. If the introduced methods are asynchronous, call the BeginInvoke method and the EndInvoke method. If the introduced methods are synchronous, call the Invoke method. The overridden constructor typically sets the Url property to the URL of the XML Web service method.

The following code example is a proxy class generated by Wsdl.exe for the Math XML Web service. The proxy class derives from SoapHttpClientProtocol, which derives from the abstract WebClientProtocol class.


namespace MyMath {
    using System.Diagnostics;
    using System.Xml.Serialization;
    using System;
    using System.Web.Services.Protocols;
    using System.Web.Services;


    [System.Web.Services.WebServiceBindingAttribute(Name="MyMathSoap", Namespace="http://www.contoso.com/")]
    public class MyMath : System.Web.Services.Protocols.SoapHttpClientProtocol {

        [System.Diagnostics.DebuggerStepThroughAttribute()]
        public MyMath() {
            this.Url = "http://www.contoso.com/math.asmx";
        }

        [System.Diagnostics.DebuggerStepThroughAttribute()]
        [System.Web.Services.Protocols.SoapDocumentMethodAttribute("http://www.contoso.com/Add", RequestNamespace="http://www.contoso.com/", ResponseNamespace="http://www.contoso.com/", Use=System.Web.Services.Description.SoapBindingUse.Literal, ParameterStyle=System.Web.Services.Protocols.SoapParameterStyle.Wrapped)]
        public int Add(int num1, int num2) {
            object[] results = this.Invoke("Add", new object[] {num1,
                        num2});
            return ((int)(results[0]));
        }

        [System.Diagnostics.DebuggerStepThroughAttribute()]
        public System.IAsyncResult BeginAdd(int num1, int num2, System.AsyncCallback callback, object asyncState) {
            return this.BeginInvoke("Add", new object[] {num1,
                        num2}, callback, asyncState);
        }

        [System.Diagnostics.DebuggerStepThroughAttribute()]
        public int EndAdd(System.IAsyncResult asyncResult) {
            object[] results = this.EndInvoke(asyncResult);
            return ((int)(results[0]));
        }
    }
}

The following code example is the Math XML Web service, from which the preceding proxy class was generated.

System_CAPS_security Security Note

This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

.NET Framework
Available since 1.1

This type is thread safe.

Return to top
Show: