HttpGetClientProtocol Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

The base class for XML Web service client proxies that use the HTTP-GET protocol.

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


Public Class HttpGetClientProtocol
	Inherits HttpSimpleClientProtocol


Initializes a new instance of the HttpGetClientProtocol class.


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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.)


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.)


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


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


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


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

System_CAPS_protmethodBeginInvoke(String, String, Object(), AsyncCallback, Object)

Starts an asynchronous invocation of a method of an XML Web service.(Inherited from HttpSimpleClientProtocol.)


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


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


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


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


Completes asynchronous invocation of an XML Web service method using HTTP.(Inherited from HttpSimpleClientProtocol.)


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


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


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


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


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


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


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


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.)


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

System_CAPS_protmethodInvoke(String, String, Object())

Invokes an XML Web service method using HTTP.(Inherited from HttpSimpleClientProtocol.)

System_CAPS_protmethodInvokeAsync(String, String, Object(), SendOrPostCallback)

Invokes the specified method asynchronously.(Inherited from HttpSimpleClientProtocol.)

System_CAPS_protmethodInvokeAsync(String, String, Object(), SendOrPostCallback, Object)

Invokes the specified method asynchronously while maintaining an associated state.(Inherited from HttpSimpleClientProtocol.)


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


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


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


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

When an XML Web service client uses the HTTP-GET protocol, parameters are encoded within the URL and the response is returned in plain XML.

If you are building an XML Web service client using ASP.NET, then a proxy class deriving indirectly or directly from WebClientProtocol needs to be created for the XML Web service you want to call. When the XML Web service client calls the XML Web service using HTTP, derive the proxy class from HttpSimpleClientProtocol, which in turn derives from WebClientProtocol.

HttpGetClientProtocol and HttpPostClientProtocol derive from HttpSimpleClientProtocol, providing the support for calling an XML Web service method using the HTTP-GET and HTTP-POST protocols respectively. Clients calling an XML Web service using SOAP should derive from SoapHttpClientProtocol.

For details on building a proxy class, see [<topic://cpconcreatingwebserviceproxy>].

The following example is a proxy class generated by Wsdl.exe for the Math XML Web service below. The proxy class derives from HttpGetClientProtocol, which derives from the abstract HttpSimpleClientProtocol class.

Option Strict On
Option Explicit On

Imports System
Imports System.Diagnostics
Imports System.Web.Services
Imports System.Web.Services.Protocols
Imports System.Xml.Serialization

Public Class MyMath
    Inherits System.Web.Services.Protocols.HttpGetClientProtocol

    <System.Diagnostics.DebuggerStepThroughAttribute()>  _
    Public Sub New()
        Me.Url = ""
    End Sub

    <System.Diagnostics.DebuggerStepThroughAttribute(),  _
     System.Web.Services.Protocols.HttpMethodAttribute(GetType(System.Web.Services.Protocols.XmlReturnReader), GetType(System.Web.Services.Protocols.UrlParameterWriter))>  _
    Public Function Add(ByVal num1 As String, ByVal num2 As String) As <System.Xml.Serialization.XmlRootAttribute("int", [Namespace]:="", IsNullable:=false)> Integer
        Return CType(Me.Invoke("Add", (Me.Url + "/Add"), New Object() {num1, num2}),Integer)
    End Function

    <System.Diagnostics.DebuggerStepThroughAttribute()>  _
    Public Function BeginAdd(ByVal num1 As String, ByVal num2 As String, ByVal callback As System.AsyncCallback, ByVal asyncState As Object) As System.IAsyncResult
        Return Me.BeginInvoke("Add", (Me.Url + "/Add"), New Object() {num1, num2}, callback, asyncState)
    End Function

    <System.Diagnostics.DebuggerStepThroughAttribute()>  _
    Public Function EndAdd(ByVal asyncResult As System.IAsyncResult) As Integer
        Return CType(Me.EndInvoke(asyncResult),Integer)
    End Function
End Class

The following example is the Math XML Web service, from which the above proxy class was created.

.NET Framework
Available since 1.1

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top