ClientBase<TChannel> Класс

Определение

Пространство имен:

System.ServiceModel

Сборка:

System.ServiceModel.Primitives.dll

Пакет:

System.ServiceModel.Primitives v8.0.0

Исходный код:

ClientBase.cs

Предоставляет базовую реализацию, используемую для создания объектов клиента Windows Communication Foundation (WCF), которые могут вызывать службы.

generic <typename TChannel>
 where TChannel : classpublic ref class ClientBase abstract : IAsyncDisposable, IDisposable, System::ServiceModel::ICommunicationObject

public abstract class ClientBase<TChannel> : IAsyncDisposable, IDisposable, System.ServiceModel.ICommunicationObject where TChannel : class

type ClientBase<'Channel (requires 'Channel : null)> = class
    interface ICommunicationObject
    interface IDisposable
    interface IAsyncDisposable

Public MustInherit Class ClientBase(Of TChannel)
Implements IAsyncDisposable, ICommunicationObject, IDisposable

Параметры типа

TChannel

Канал, используемый для подключения к службе.

Наследование

Object

ClientBase<TChannel>

Производный

System.ServiceModel.Activities.WorkflowControlClient

System.ServiceModel.Activities.WorkflowUpdateableControlClient

System.ServiceModel.DuplexClientBase<TChannel>

Реализации

IDisposable ICommunicationObject IAsyncDisposable

Примеры

В следующем примере кода показано, как средство serviceModel Metadata Utility Tool (Svcutil.exe) расширяет ClientBase<TChannel> класс для создания класса клиента WCF.

public partial class SampleServiceClient : System.ServiceModel.ClientBase<ISampleService>, ISampleService
{

    public SampleServiceClient()
    {
    }

    public SampleServiceClient(string endpointConfigurationName) :
            base(endpointConfigurationName)
    {
    }

    public SampleServiceClient(string endpointConfigurationName, string remoteAddress) :
            base(endpointConfigurationName, remoteAddress)
    {
    }

    public SampleServiceClient(string endpointConfigurationName, System.ServiceModel.EndpointAddress remoteAddress) :
            base(endpointConfigurationName, remoteAddress)
    {
    }

    public SampleServiceClient(System.ServiceModel.Channels.Binding binding, System.ServiceModel.EndpointAddress remoteAddress) :
            base(binding, remoteAddress)
    {
    }

    public string SampleMethod(string msg)
    {
        return base.Channel.SampleMethod(msg);
    }
}

<System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")> _
Partial Public Class SampleServiceClient
    Inherits System.ServiceModel.ClientBase(Of ISampleService)
    Implements ISampleService

    Public Sub New()
    End Sub

    Public Sub New(ByVal endpointConfigurationName As String)
        MyBase.New(endpointConfigurationName)
    End Sub

    Public Sub New(ByVal endpointConfigurationName As String, ByVal remoteAddress As String)
        MyBase.New(endpointConfigurationName, remoteAddress)
    End Sub

    Public Sub New(ByVal endpointConfigurationName As String, _
                   ByVal remoteAddress As System.ServiceModel.EndpointAddress)
        MyBase.New(endpointConfigurationName, remoteAddress)
    End Sub

    Public Sub New(ByVal binding As System.ServiceModel.Channels.Binding, _
                   ByVal remoteAddress As System.ServiceModel.EndpointAddress)
        MyBase.New(binding, remoteAddress)
    End Sub

    Public Function SampleMethod(ByVal msg As String) As String Implements ISampleService.SampleMethod
        Return MyBase.Channel.SampleMethod(msg)
    End Function
End Class

Комментарии

Расширьте класс , ClientBase<TChannel> чтобы создать пользовательский клиентский объект WCF, который можно использовать для подключения к службе. Как правило, базовый класс клиента WCF расширяется с помощью такого средства, как serviceModel Metadata Utility Tool (Svcutil.exe) от вашего имени. См. пример в разделе "Пример".

Класс ClientBase<TChannel> могут легко и быстро использовать разработчики, которые предпочитают, чтобы объекты использовали интерфейсы и класс System.ServiceModel.ChannelFactory<TChannel>. В любом случае этот класс создает оболочку или предоставляет методы и функциональные возможности класса System.ServiceModel.ChannelFactory<TChannel> и интерфейса System.ServiceModel.IClientChannel.

Как и при использовании класса System.ServiceModel.ServiceHost, можно создать класс и изменить конечную точку, фабрику каналов или сведения о безопасности до вызова метода Open. Дополнительные сведения см. в разделах Общие сведения о клиенте WCF и Доступ к службам с помощью клиента WCF.

Особое примечание для пользователей управляемого кода C++, создающих классы, унаследованные от данного.

• Поместите код очистки в блок (On)(Begin)Close (или OnAbort), а не в деструктор.

• Избегайте использования деструкторов, поскольку они приводят к тому, что компилятор автоматически создает IDisposable.

• Избегайте использования нессылочных членов, поскольку они приводят к тому, что компилятор автоматически создает IDisposable.

• Избегайте использования методов завершения. При включении этого метода необходимо подавить предупреждение построения и вызвать SuppressFinalize(Object) и сам метод завершения из блока (On)(Begin)Close (или OnAbort) для эмуляции автоматического поведения IDisposable.

Конструкторы

ClientBase<TChannel>()	Инициализирует новый экземпляр класса ClientBase<TChannel>, используя целевую конечную точку по умолчанию из файла конфигурации приложения.
ClientBase<TChannel>(Binding, EndpointAddress)	Инициализирует новый экземпляр класса ClientBase<TChannel>, используя указанную привязку и целевой адрес.
ClientBase<TChannel>(InstanceContext, Binding, EndpointAddress)	Инициализирует новый экземпляр класса ClientBase<TChannel>.
ClientBase<TChannel>(ServiceEndpoint)	Инициализирует новый экземпляр класса ClientBase<TChannel> с использованием указанного объекта ServiceEndpoint.

Свойства

CacheSetting	Получает или задает параметр кэша.
Channel	Получает внутренний канал, используемый для отправки сообщений в настроенные различным образом конечные точки служб.
ChannelFactory	Возвращает базовый объект ChannelFactory<TChannel>.
ClientCredentials	Возвращает учетные данные клиента, используемые для вызова операции.
Endpoint	Возвращает целевую конечную точку службы, к которой может подключиться клиент WCF.
InnerChannel	Возвращает базовую реализацию IClientChannel.
State	Возвращает текущее состояние объекта ClientBase<TChannel>.

Методы

Abort()	Вызывает мгновенный переход объекта ClientBase<TChannel> из текущего состояния в состояние Closed.
Close()	Вызывает переход объекта ClientBase<TChannel> из текущего состояния в состояние Closed.
CloseAsync()	Предоставляет базовую реализацию, используемую для создания объектов клиента Windows Communication Foundation (WCF), которые могут вызывать службы.
CreateChannel()	Возвращает новый канал к службе.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
GetDefaultValueForInitialization<T>()	Реплицирует поведение ключевого слова по умолчанию в C#.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
InvokeAsync(ClientBase<TChannel>.BeginOperationDelegate, Object[], ClientBase<TChannel>.EndOperationDelegate, SendOrPostCallback, Object)	Обеспечивает поддержку реализации асинхронной модели, основанной на событиях. Дополнительные сведения об этом шаблоне см. в разделе Обзор асинхронной модели на основе событий.
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
Open()	Вызывает переход объекта ClientBase<TChannel> из состояния Created в состояние Opened.
OpenAsync()	Предоставляет базовую реализацию, используемую для создания объектов клиента Windows Communication Foundation (WCF), которые могут вызывать службы.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

Явные реализации интерфейса

IAsyncDisposable.DisposeAsync()	Предоставляет базовую реализацию, используемую для создания объектов клиента Windows Communication Foundation (WCF), которые могут вызывать службы.
ICommunicationObject.BeginClose(AsyncCallback, Object)	Начинает асинхронную операцию закрытия объекта ClientBase<TChannel>.
ICommunicationObject.BeginClose(TimeSpan, AsyncCallback, Object)	Начинает асинхронную операцию закрытия объекта ClientBase<TChannel> с заданным временем ожидания.
ICommunicationObject.BeginOpen(AsyncCallback, Object)	Начинает асинхронную операцию открытия объекта ClientBase<TChannel>.
ICommunicationObject.BeginOpen(TimeSpan, AsyncCallback, Object)	Начинает асинхронную операцию открытия объекта ClientBase<TChannel> в течение заданного интервала времени.
ICommunicationObject.Close(TimeSpan)	Вызывает переход объекта ClientBase<TChannel> из текущего состояния в состояние Closed.
ICommunicationObject.Closed	Обработчик событий, вызываемый после перехода объекта ClientBase<TChannel> из текущего состояния в состояние Closed.
ICommunicationObject.Closing	Обработчик событий, вызываемый при переходе объекта ClientBase<TChannel> из текущего состояния в состояние Closed.
ICommunicationObject.EndClose(IAsyncResult)	Завершает асинхронную операцию закрытия объекта ClientBase<TChannel>.
ICommunicationObject.EndOpen(IAsyncResult)	Завершает асинхронную операцию открытия объекта ClientBase<TChannel>.
ICommunicationObject.Faulted	Обработчик событий, вызываемый при возникновении ошибки во время выполнения операции в объекте ClientBase<TChannel>.
ICommunicationObject.Open(TimeSpan)	Вызывает переход объекта ClientBase<TChannel> из состояния Created в состояние Opened в течение заданного интервала времени.
ICommunicationObject.Opened	Обработчик событий, вызываемый при переходе объекта ClientBase<TChannel> из состояния Created в состояние Opened.
ICommunicationObject.Opening	Обработчик событий, вызываемый при переходе объекта ClientBase<TChannel> из состояния Created в состояние Opened.
IDisposable.Dispose()	Явная реализация метода Dispose().

Методы расширения

CloseHelperAsync(ICommunicationObject, TimeSpan)	Предоставляет базовую реализацию, используемую для создания объектов клиента Windows Communication Foundation (WCF), которые могут вызывать службы.
OpenHelperAsync(ICommunicationObject, TimeSpan)	Предоставляет базовую реализацию, используемую для создания объектов клиента Windows Communication Foundation (WCF), которые могут вызывать службы.
ConfigureAwait(IAsyncDisposable, Boolean)	Настраивает способ выполнения ожиданий для задач, возвращаемых из асинхронного высвобождаемого объекта.