ContractDescription ContractDescription ContractDescription ContractDescription Class

Определение

Описывает контракт Windows Communication Foundation (WCF), который указывает, чем конечная точка обменивается с внешним миром.Describes a Windows Communication Foundation (WCF) contract that specifies what an endpoint communicates to the outside world.

public ref class ContractDescription
public class ContractDescription
type ContractDescription = class
Public Class ContractDescription
Наследование
ContractDescriptionContractDescriptionContractDescriptionContractDescription

Примеры

В следующем примере показано несколько способов создания или извлечения объекта ContractDescription.The following example shows a number of ways to create or retrieve a ContractDescription object. Далее в нем представляются различные элементы данных, которые сохраняются в объекте ContractDescription.It then displays the various pieces of information that are stored in the ContractDescription object.

           Uri baseAddress = new Uri("http://localhost:8001/Simple");
           ServiceHost serviceHost = new ServiceHost(typeof(CalculatorService), baseAddress);

           serviceHost.AddServiceEndpoint(
               typeof(ICalculator),
               new WSHttpBinding(),
               "CalculatorServiceObject");

           // Enable Mex
           ServiceMetadataBehavior smb = new ServiceMetadataBehavior();
           smb.HttpGetEnabled = true;
           serviceHost.Description.Behaviors.Add(smb);

           serviceHost.Open();

           ContractDescription cd0 = new ContractDescription("ICalculator");
           ContractDescription cd1 = new ContractDescription("ICalculator", "http://www.tempuri.org");
           ContractDescription cd2 = ContractDescription.GetContract(typeof(ICalculator));
           CalculatorService calcSvc = new CalculatorService();
           ContractDescription cd3 = ContractDescription.GetContract(typeof(ICalculator), calcSvc);
           ContractDescription cd4 = ContractDescription.GetContract(typeof(ICalculator), typeof(CalculatorService));
           ContractDescription cd = serviceHost.Description.Endpoints[0].Contract;         

           Console.WriteLine("Displaying information for contract: {0}", cd.Name.ToString());

           KeyedByTypeCollection<IContractBehavior> behaviors = cd.Behaviors;
           Console.WriteLine("\tDisplay all behaviors:");
           foreach (IContractBehavior behavior in behaviors)
           {
               Console.WriteLine("\t\t" + behavior.ToString());
           }

           Type type = cd.CallbackContractType;

           string configName = cd.ConfigurationName;
           Console.WriteLine("\tConfiguration name: {0}", configName);

           Type contractType = cd.ContractType;
           Console.WriteLine("\tContract type: {0}", contractType.ToString());

           bool hasProtectionLevel = cd.HasProtectionLevel;
           if (hasProtectionLevel)
           {
               ProtectionLevel protectionLevel = cd.ProtectionLevel;
               Console.WriteLine("\tProtection Level: {0}", protectionLevel.ToString());
           }

           
           string name = cd.Name;
           Console.WriteLine("\tName: {0}", name);

           string namespc = cd.Namespace;
           Console.WriteLine("\tNamespace: {0}", namespc);

           OperationDescriptionCollection odc = cd.Operations;
           Console.WriteLine("\tDisplay Operations:");
           foreach (OperationDescription od in odc)
           {
               Console.WriteLine("\t\t" + od.Name);
           }

           SessionMode sm = cd.SessionMode;
           Console.WriteLine("\tSessionMode: {0}", sm.ToString());

           Collection<ContractDescription> inheretedContracts = cd.GetInheritedContracts();
           Console.WriteLine("\tInherited Contracts:");
           foreach (ContractDescription contractdescription in inheretedContracts)
           {
               Console.WriteLine("\t\t" + contractdescription.Name);
           }

           Console.WriteLine("The service is ready.");
           Console.WriteLine("Press <ENTER> to terminate service.");
           Console.WriteLine();
           Console.ReadLine();

           // Close the ServiceHostBase to shutdown the service.
           serviceHost.Close();
Dim baseAddress As New Uri("http://localhost:8001/Simple")
Dim serviceHost As New ServiceHost(GetType(CalculatorService), baseAddress)

serviceHost.AddServiceEndpoint(GetType(ICalculator), New WSHttpBinding(), "CalculatorServiceObject")

' Enable Mex
Dim smb As New ServiceMetadataBehavior()
smb.HttpGetEnabled = True
serviceHost.Description.Behaviors.Add(smb)

serviceHost.Open()

Dim cd0 As New ContractDescription("ICalculator")
Dim cd1 As New ContractDescription("ICalculator", "http://www.tempuri.org")
Dim cd2 As ContractDescription = ContractDescription.GetContract(GetType(ICalculator))
Dim calcSvc As New CalculatorService()
Dim cd3 As ContractDescription = ContractDescription.GetContract(GetType(ICalculator), calcSvc)
Dim cd4 As ContractDescription = ContractDescription.GetContract(GetType(ICalculator), GetType(CalculatorService))
Dim cd As ContractDescription = serviceHost.Description.Endpoints(0).Contract

Console.WriteLine("Displaying information for contract: {0}", cd.Name.ToString())

Dim behaviors As KeyedByTypeCollection(Of IContractBehavior) = cd.Behaviors
Console.WriteLine(Constants.vbTab & "Display all behaviors:")
For Each behavior As IContractBehavior In behaviors
    Console.WriteLine(Constants.vbTab + Constants.vbTab + CType(behavior, Object).ToString())
Next behavior

Dim type As Type = cd.CallbackContractType

Dim configName As String = cd.ConfigurationName
Console.WriteLine(Constants.vbTab & "Configuration name: {0}", configName)

Dim contractType As Type = cd.ContractType
Console.WriteLine(Constants.vbTab & "Contract type: {0}", contractType.ToString())

Dim hasProtectionLevel As Boolean = cd.HasProtectionLevel
If hasProtectionLevel Then
    Dim protectionLevel As ProtectionLevel = cd.ProtectionLevel
    Console.WriteLine(Constants.vbTab & "Protection Level: {0}", protectionLevel.ToString())
End If


Dim name As String = cd.Name
Console.WriteLine(Constants.vbTab & "Name: {0}", name)

Dim namespc As String = cd.Namespace
Console.WriteLine(Constants.vbTab & "Namespace: {0}", namespc)

Dim odc As OperationDescriptionCollection = cd.Operations
Console.WriteLine(Constants.vbTab & "Display Operations:")
For Each od As OperationDescription In odc
    Console.WriteLine(Constants.vbTab + Constants.vbTab + od.Name)
Next od

Dim sm As SessionMode = cd.SessionMode
Console.WriteLine(Constants.vbTab & "SessionMode: {0}", sm.ToString())

Dim inheretedContracts As Collection(Of ContractDescription) = cd.GetInheritedContracts()
Console.WriteLine(Constants.vbTab & "Inherited Contracts:")
For Each contractdescription As ContractDescription In inheretedContracts
    Console.WriteLine(Constants.vbTab + Constants.vbTab + contractdescription.Name)
Next contractdescription

Console.WriteLine("The service is ready.")
Console.WriteLine("Press <ENTER> to terminate service.")
Console.WriteLine()
Console.ReadLine()

' Close the ServiceHostBase to shutdown the service.
serviceHost.Close()

Комментарии

Контракт WCF — это набор операций, который указывает, что конечная точка взаимодействует с внешним миром.A WCF contract is a collection of operations that specifies what the endpoint communicates to the outside world. Каждая операция является обменом сообщениями.Each operation is a message exchange. Например, сообщение запроса и соответствующее ответное сообщение образуют обмен сообщениями запрос-ответ.For example, a request message and an associated reply message form a request/reply message exchange.

Объект ContractDescription используется для описания контрактов WCF и их операций.A ContractDescription object is used to describe WCF contracts and their operations. Внутри ContractDescription каждая операция контракта имеет соответствующий объект OperationDescription, который описывает аспекты каждой операции, являющейся частью контракта. Например, является ли операция однонаправленной или предполагает работу в режиме запрос-ответ.Within a ContractDescription, each contract operation has a corresponding OperationDescription that describes aspects of the each operation that is part of the contract, such as whether the operation is one-way or request/reply. Каждый объект OperationDescription также описывает сообщения, составляющие операцию, которая использует коллекцию MessageDescriptionCollection.Each OperationDescription also describes the messages that make up the operation using a MessageDescriptionCollection. ContractDescriptionсодержит ссылку на интерфейс, который определяет контракт с использованием модели программирования.ContractDescription contains a reference to an interface that defines the contract using the programming model. Этот интерфейс отмечен атрибутом ServiceContractAttribute, а его методы, соответствующие операциям конечной точки, отмечены атрибутом OperationContractAttribute.This interface is marked with ServiceContractAttribute and its methods that correspond to endpoint operations are marked with the OperationContractAttribute.

Дуплексный контракт определяет следующие логические наборы операций:A duplex contract defines the following logical sets of operations:

  • Набор, который служба представляет клиенту для вызова.A set that the service exposes for the client to call.

  • Набор, который клиент представляет службе для вызова.A set that the client exposes for the service to call.

В модели программирования для определения дуплексного контракта предполагается выделение каждого набора в отдельный интерфейс и применение атрибутов к каждому интерфейсу.The programming model for defining a duplex contract is to split each set in a separate interface and apply attributes to each interface. В этом случае объект ContractDescription содержит ссылки на каждый из интерфейсов, которые группируют их в один дуплексный контракт.In this case, ContractDescription contains a reference to each of the interfaces that groups them into one duplex contract.

Аналогично привязкам, каждый контракт имеет свойства Name и Namespace, которые однозначно идентифицируют его в метаданных службы.Similar to bindings, each contract has a Name and Namespace that uniquely identify it in the metadata of the service.

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

ContractDescription(String) ContractDescription(String) ContractDescription(String) ContractDescription(String)

Инициализирует новый экземпляр класса ContractDescription с указанным именем.Initializes a new instance of the ContractDescription class with a specified name.

ContractDescription(String, String) ContractDescription(String, String) ContractDescription(String, String) ContractDescription(String, String)

Инициализирует новый экземпляр класса ContractDescription с именем, для которого указано пространство имен.Initializes a new instance of the ContractDescription class with a namespace-qualified name specified.

Свойства

Behaviors Behaviors Behaviors Behaviors

Возвращает поведения, связанные с описанием контракта.Gets the behaviors associated with the contract description.

CallbackContractType CallbackContractType CallbackContractType CallbackContractType

Возвращает или задает тип контракта обратного вызова, указанного в описании контракта.Gets or sets the type of callback contract that the contract description specifies.

ConfigurationName ConfigurationName ConfigurationName ConfigurationName

Возвращает или задает имя конфигурации для описания контракта.Gets or sets the configuration name for the contract description.

ContractBehaviors ContractBehaviors ContractBehaviors ContractBehaviors

Получает коллекцию поведения для контракта.Gets the collection of behavior for the contract.

ContractType ContractType ContractType ContractType

Возвращает или задает тип контракта, указанный в описании контракта.Gets or sets the contract type that the contract description specifies.

HasProtectionLevel HasProtectionLevel HasProtectionLevel HasProtectionLevel

Возвращает значение, указывающее, установлен ли для контракта уровень защиты.Gets a value that indicates whether the contract has had a protection level set.

Name Name Name Name

Возвращает или задает имя контракта.Gets or sets the name of the contract.

Namespace Namespace Namespace Namespace

Возвращает или задает пространство имен для контракта.Gets or sets the namespace for the contract.

Operations Operations Operations Operations

Возвращает коллекцию описаний операций, связанных с контрактом.Gets the collection of operation descriptions associated with the contract.

ProtectionLevel ProtectionLevel ProtectionLevel ProtectionLevel

Возвращает или задает уровень защиты, связанной с контрактом.Gets or sets the level of security protection associated with the contract.

SessionMode SessionMode SessionMode SessionMode

Возвращает или задает значение, указывающее, требуется ли контракту сеанс.Gets or sets a value that indicates whether a session is required by the contract.

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetContract(Type) GetContract(Type) GetContract(Type) GetContract(Type)

Возвращает описание для указанного типа контракта.Returns the contract description for a specified type of contract.

GetContract(Type, Object) GetContract(Type, Object) GetContract(Type, Object) GetContract(Type, Object)

Возвращает описание контракта для указанного типа контракта и реализации службы.Returns the contract description for a specified type of contract and service implementation.

GetContract(Type, Type) GetContract(Type, Type) GetContract(Type, Type) GetContract(Type, Type)

Возвращает описание контракта для указанного типа контракта и указанного типа службы.Returns the contract description for a specified type of contract and a specified type of service.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetInheritedContracts() GetInheritedContracts() GetInheritedContracts() GetInheritedContracts()

Возвращает коллекцию описаний контракта, наследуемых текущим описанием контракта.Returns a collection of contract descriptions that are inherited by the current contract description.

GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ShouldSerializeProtectionLevel() ShouldSerializeProtectionLevel() ShouldSerializeProtectionLevel() ShouldSerializeProtectionLevel()

Возвращает значение, указывающее, изменилось ли значение свойства ProtectionLevel относительно значения по умолчанию и нужно ли его сериализовать.Returns a value that indicates whether the ProtectionLevel property has changed from its default value and should be serialized.

ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Применяется к