HttpGetClientProtocol Class

Reference

Definition

Namespace:: System.Web.Services.Protocols

Assembly:: System.Web.Services.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class HttpGetClientProtocol : System::Web::Services::Protocols::HttpSimpleClientProtocol

public class HttpGetClientProtocol : System.Web.Services.Protocols.HttpSimpleClientProtocol

type HttpGetClientProtocol = class
    inherit HttpSimpleClientProtocol

Public Class HttpGetClientProtocol
Inherits HttpSimpleClientProtocol

Inheritance: Object

MarshalByRefObject

Component

WebClientProtocol

HttpWebClientProtocol

HttpSimpleClientProtocol
HttpGetClientProtocol

Examples

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.

#using <System.Web.Services.dll>
#using <System.Xml.dll>
#using <System.dll>

using namespace System::Diagnostics;
using namespace System::Xml::Serialization;
using namespace System;
using namespace System::Web::Services::Protocols;
using namespace System::Web::Services;

public ref class MyMath: public System::Web::Services::Protocols::HttpGetClientProtocol
{
public:

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

   [System::Diagnostics::DebuggerStepThroughAttribute]
   [System::Web::Services::Protocols::HttpMethodAttribute(System::Web::Services::Protocols::XmlReturnReader::typeid,
   System::Web::Services::Protocols::UrlParameterWriter::typeid)]
   [returnvalue:System::Xml::Serialization::XmlRootAttribute("snippet1>",Namespace="http://www.contoso.com/",IsNullable=false)]
   int Add( String^ num1, String^ num2 )
   {
      array<Object^>^temp0 = {num1,num2};
      return  *dynamic_cast<int^>(this->Invoke( "Add", (String::Concat( this->Url, "/Add" )), temp0 ));
   }

   [System::Diagnostics::DebuggerStepThroughAttribute]
   System::IAsyncResult^ BeginAdd( String^ num1, String^ num2, System::AsyncCallback^ callback, Object^ asyncState )
   {
      array<Object^>^temp1 = {num1,num2};
      return this->BeginInvoke( "Add", (String::Concat( this->Url, "/Add" )), temp1, callback, asyncState );
   }

   [System::Diagnostics::DebuggerStepThroughAttribute]
   int EndAdd( System::IAsyncResult^ asyncResult )
   {
      return  *dynamic_cast<int^>(this->EndInvoke( asyncResult ));
   }
};

using System.Diagnostics;
using System.Xml.Serialization;
using System;
using System.Web.Services.Protocols;
using System.Web.Services;

public class MyMath : System.Web.Services.Protocols.HttpGetClientProtocol {

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

    [System.Diagnostics.DebuggerStepThroughAttribute()]
    [System.Web.Services.Protocols.HttpMethodAttribute(typeof(System.Web.Services.Protocols.XmlReturnReader), typeof(System.Web.Services.Protocols.UrlParameterWriter))]
    [return: System.Xml.Serialization.XmlRootAttribute("int", Namespace = "http://www.contoso.com/", IsNullable = false)]
    public int Add(string num1, string num2)
    {
        return ((int)(this.Invoke("Add", (this.Url + "/Add"),
            new object[] { num1, num2 })));
    }

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

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

Option Strict On
Option Explicit On

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()
        MyBase.New
        Me.Url = "http://www.contoso.com/math.asmx"
    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]:="http://www.contoso.com/", 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.

<%@ WebService Language="C#" Class="Math"%>
 using System.Web.Services;
 using System;
 
 public class Math {
      [ WebMethod ]
      public int Add(int num1, int num2) {
          return num1+num2;
          }
 }

<%@ WebService Language="VB" Class="Math"%>
Imports System.Web.Services
Imports System

Public Class Math
    <WebMethod()> _
    Public Function Add(num1 As Integer, num2 As Integer) As Integer
        Return num1 + num2
    End Function 'Add
End Class 'Math

Remarks

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 Creating an XML Web Service Proxy.

Constructors

HttpGetClientProtocol()

Initializes a new instance of the HttpGetClientProtocol class.

Properties

AllowAutoRedirect	Gets or sets whether the client automatically follows server redirects. (Inherited from HttpWebClientProtocol)
CanRaiseEvents	Gets a value indicating whether the component can raise an event. (Inherited from Component)
ClientCertificates	Gets the collection of client certificates. (Inherited from HttpWebClientProtocol)
ConnectionGroupName	Gets or sets the name of the connection group for the request. (Inherited from WebClientProtocol)
Container	Gets the IContainer that contains the Component. (Inherited from Component)
CookieContainer	Gets or sets the collection of cookies. (Inherited from HttpWebClientProtocol)
Credentials	Gets or sets security credentials for XML Web service client authentication. (Inherited from WebClientProtocol)
DesignMode	Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component)
EnableDecompression	Gets or sets a value that indicates whether decompression is enabled for this HttpWebClientProtocol. (Inherited from HttpWebClientProtocol)
Events	Gets the list of event handlers that are attached to this Component. (Inherited from Component)
PreAuthenticate	Gets or sets whether pre-authentication is enabled. (Inherited from WebClientProtocol)
Proxy	Gets or sets proxy information for making an XML Web service request through a firewall. (Inherited from HttpWebClientProtocol)
RequestEncoding	The Encoding used to make the client request to the XML Web service. (Inherited from WebClientProtocol)
Site	Gets or sets the ISite of the Component. (Inherited from Component)
Timeout	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)
UnsafeAuthenticatedConnectionSharing	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)
Url	Gets or sets the base URL of the XML Web service the client is requesting. (Inherited from WebClientProtocol)
UseDefaultCredentials	Gets or sets a value that indicates whether to set the Credentials property to the value of the DefaultCredentials property. (Inherited from WebClientProtocol)
UserAgent	Gets or sets the value for the user agent header that is sent with each request. (Inherited from HttpWebClientProtocol)

Methods

Abort()	Cancels a request to an XML Web service method. (Inherited from WebClientProtocol)
BeginInvoke(String, String, Object[], AsyncCallback, Object)	Starts an asynchronous invocation of a method of an XML Web service. (Inherited from HttpSimpleClientProtocol)
CancelAsync(Object)	Cancels an asynchronous call to an XML Web service method, unless the call has already completed. (Inherited from HttpWebClientProtocol)
CreateObjRef(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)
Dispose()	Releases all resources used by the Component. (Inherited from Component)
Dispose(Boolean)	Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component)
EndInvoke(IAsyncResult)	Completes asynchronous invocation of an XML Web service method using HTTP. (Inherited from HttpSimpleClientProtocol)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetLifetimeService()	Obsolete. Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject)
GetService(Type)	Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetWebRequest(Uri)	Creates a WebRequest instance for the specified URI.
GetWebResponse(WebRequest, IAsyncResult)	Returns a response from an asynchronous request to an XML Web service method. (Inherited from HttpWebClientProtocol)
GetWebResponse(WebRequest)	Returns a response from a synchronous request to an XML Web service method. (Inherited from HttpWebClientProtocol)
InitializeLifetimeService()	Obsolete. Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject)
Invoke(String, String, Object[])	Invokes an XML Web service method using HTTP. (Inherited from HttpSimpleClientProtocol)
InvokeAsync(String, String, Object[], SendOrPostCallback, Object)	Invokes the specified method asynchronously while maintaining an associated state. (Inherited from HttpSimpleClientProtocol)
InvokeAsync(String, String, Object[], SendOrPostCallback)	Invokes the specified method asynchronously. (Inherited from HttpSimpleClientProtocol)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject)
ToString()	Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component)

Events

Disposed

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

(Inherited from Component)

Applies to

Jaa