HttpSimpleClientProtocol Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Представляет базовый класс для взаимодействия с веб-службой XML с помощью простых HTTP-GET и HTTP-POST протоколов.
public ref class HttpSimpleClientProtocol abstract : System::Web::Services::Protocols::HttpWebClientProtocol
public abstract class HttpSimpleClientProtocol : System.Web.Services.Protocols.HttpWebClientProtocol
[System.Runtime.InteropServices.ComVisible(true)]
public abstract class HttpSimpleClientProtocol : System.Web.Services.Protocols.HttpWebClientProtocol
type HttpSimpleClientProtocol = class
inherit HttpWebClientProtocol
[<System.Runtime.InteropServices.ComVisible(true)>]
type HttpSimpleClientProtocol = class
inherit HttpWebClientProtocol
Public MustInherit Class HttpSimpleClientProtocol
Inherits HttpWebClientProtocol
- Наследование
-
HttpSimpleClientProtocol
- Производный
- Атрибуты
Примеры
Следующий пример кода — это класс прокси-сервера, созданный Wsdl.exe для Math веб-службы XML ниже. Прокси-класс является производным от HttpGetClientProtocolкласса, производным от абстрактного HttpSimpleClientProtocol класса.
#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
Следующий пример кода — это Math веб-служба XML, из которой был создан предыдущий прокси-класс.
#using <System.EnterpriseServices.dll>
#using <System.Web.Services.dll>
using namespace System::Web::Services;
using namespace System;
public ref class Math
{
public:
[WebMethod]
int Add( int num1, int num2 )
{
return num1 + num2;
}
};
using System.Web.Services;
using System;
public class Math
{
[WebMethod]
public int Add(int num1, int num2)
{
return num1 + num2;
}
}
Imports System.Web.Services
Public Class Math
<WebMethod()> _
Public Function Add(num1 As Integer, num2 As Integer)As Integer
Return num1 + num2
End Function
End Class
Комментарии
Этот класс задает большую часть реализации для взаимодействия с веб-службой XML по протоколу HTTP с помощью кодировщиков для кодирования параметров и возврата значений в общие форматы MIME. Эти кодировщики являются производными MimeFormatter от класса. По умолчанию класс прокси-сервера, производный от параметров кодирования с HttpSimpleClientProtocol помощью типа MIME application/x-www-form-urlencoded и ответа в формате обычного XML. Пользовательские формататоры mime можно указать с помощью атрибута HttpMethodAttribute , однако не поддерживается интеграция этого элемента в описание службы и создание прокси-сервера.
Notes to Inheritors: При переопределении этого класса можно ввести методы в производном классе, относящееся к конкретному типу веб-службы XML. Методы просто захватывают параметры и вызывают базовый класс для выполнения работы взаимодействия с сайтом. Если введенные методы являются асинхронными, вызовите BeginInvoke методы и EndInvoke методы. Если введенные методы синхронны, вызовите Invoke метод. Переопределенный конструктор обычно задает Url свойство URI метода веб-службы XML.
Средство языка описания веб-служб (Wsdl.exe) создает производные классы для заданного HttpSimpleClientProtocol описания службы.
Конструкторы
| Имя | Описание |
|---|---|
| HttpSimpleClientProtocol() |
Инициализирует новый экземпляр класса HttpSimpleClientProtocol. |
Свойства
| Имя | Описание |
|---|---|
| AllowAutoRedirect |
Возвращает или задает, следует ли клиенту автоматически выполнять перенаправления сервера. (Унаследовано от HttpWebClientProtocol) |
| CanRaiseEvents |
Возвращает значение, указывающее, может ли компонент вызвать событие. (Унаследовано от Component) |
| ClientCertificates |
Возвращает коллекцию сертификатов клиента. (Унаследовано от HttpWebClientProtocol) |
| ConnectionGroupName |
Возвращает или задает имя группы подключений для запроса. (Унаследовано от WebClientProtocol) |
| Container |
Возвращает объект IContainer , содержащий Componentобъект . (Унаследовано от Component) |
| CookieContainer |
Возвращает или задает коллекцию файлов cookie. (Унаследовано от HttpWebClientProtocol) |
| Credentials |
Возвращает или задает учетные данные безопасности для проверки подлинности клиента веб-службы XML. (Унаследовано от WebClientProtocol) |
| DesignMode |
Возвращает значение, указывающее, находится ли текущий Component режим разработки. (Унаследовано от Component) |
| EnableDecompression |
Возвращает или задает значение, указывающее, включена ли декомпрессия для этого HttpWebClientProtocol. (Унаследовано от HttpWebClientProtocol) |
| Events |
Возвращает список обработчиков событий, подключенных к этому Component. (Унаследовано от Component) |
| PreAuthenticate |
Возвращает или задает, включена ли предварительная проверка подлинности. (Унаследовано от WebClientProtocol) |
| Proxy |
Возвращает или задает сведения о прокси-сервере для выполнения запроса веб-службы XML через брандмауэр. (Унаследовано от HttpWebClientProtocol) |
| RequestEncoding |
Используется Encoding для запроса клиента к веб-службе XML. (Унаследовано от WebClientProtocol) |
| Site |
Возвращает или задает ISite объект Component. (Унаследовано от Component) |
| Timeout |
Указывает время, когда клиент веб-службы XML ожидает ответа на синхронный запрос веб-службы XML (в миллисекундах). (Унаследовано от WebClientProtocol) |
| UnsafeAuthenticatedConnectionSharing |
Возвращает или задает значение, указывающее, включен ли общий доступ к подключению, если клиент использует проверку подлинности NTLM для подключения к веб-серверу, на котором размещена веб-служба XML. (Унаследовано от HttpWebClientProtocol) |
| Url |
Возвращает или задает базовый URL-адрес веб-службы XML, запрашиваемой клиентом. (Унаследовано от WebClientProtocol) |
| UseDefaultCredentials |
Возвращает или задает значение, указывающее, следует ли задать Credentials свойство значению DefaultCredentials свойства. (Унаследовано от WebClientProtocol) |
| UserAgent |
Возвращает или задает значение заголовка агента пользователя, отправляемого с каждым запросом. (Унаследовано от HttpWebClientProtocol) |
Методы
| Имя | Описание |
|---|---|
| Abort() |
Отменяет запрос к методу веб-службы XML. (Унаследовано от WebClientProtocol) |
| BeginInvoke(String, String, Object[], AsyncCallback, Object) |
Запускает асинхронное вызов метода веб-службы XML. |
| CancelAsync(Object) |
Отменяет асинхронный вызов метода веб-службы XML, если вызов еще не завершен. (Унаследовано от HttpWebClientProtocol) |
| CreateObjRef(Type) |
Создает объект, содержащий все соответствующие сведения, необходимые для создания прокси-сервера, используемого для взаимодействия с удаленным объектом. (Унаследовано от MarshalByRefObject) |
| Dispose() |
Освобождает все ресурсы, используемые параметром Component. (Унаследовано от Component) |
| Dispose(Boolean) |
Освобождает неуправляемые ресурсы, используемые Component и при необходимости освобождает управляемые ресурсы. (Унаследовано от Component) |
| EndInvoke(IAsyncResult) |
Завершает асинхронное вызов метода веб-службы XML с помощью ПРОТОКОЛА HTTP. |
| Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
| GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
| GetLifetimeService() |
Устаревшие..
Извлекает текущий объект службы времени существования, который управляет политикой времени существования для этого экземпляра. (Унаследовано от MarshalByRefObject) |
| GetService(Type) |
Возвращает объект, представляющий службу, предоставляемую Component или ее Container. (Унаследовано от Component) |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| GetWebRequest(Uri) |
WebRequest Создает для указанного URI. (Унаследовано от HttpWebClientProtocol) |
| GetWebResponse(WebRequest, IAsyncResult) |
Возвращает ответ от асинхронного запроса к методу веб-службы XML. (Унаследовано от HttpWebClientProtocol) |
| GetWebResponse(WebRequest) |
Возвращает ответ от синхронного запроса к методу веб-службы XML. (Унаследовано от HttpWebClientProtocol) |
| InitializeLifetimeService() |
Устаревшие..
Получает объект службы времени существования для управления политикой времени существования для этого экземпляра. (Унаследовано от MarshalByRefObject) |
| Invoke(String, String, Object[]) |
Вызывает метод веб-службы XML с помощью HTTP. |
| InvokeAsync(String, String, Object[], SendOrPostCallback, Object) |
Вызывает указанный метод асинхронно при сохранении связанного состояния. |
| InvokeAsync(String, String, Object[], SendOrPostCallback) |
Вызывает указанный метод асинхронно. |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| MemberwiseClone(Boolean) |
Создает неглубокую копию текущего MarshalByRefObject объекта. (Унаследовано от MarshalByRefObject) |
| ToString() |
String Возвращает имя, содержащее имя , если таковое Componentимеется. Этот метод не должен быть переопределен. (Унаследовано от Component) |
События
| Имя | Описание |
|---|---|
| Disposed |
Происходит при удалении компонента вызовом Dispose() метода. (Унаследовано от Component) |
Применяется к
Потокобезопасность
Этот тип является потокобезопасной.