双工

项目
05/10/2023

“双工”示例演示如何定义和实现双工协定。当客户端与服务建立会话并为服务提供可用来将消息发送回客户端的通道时，就会发生双工通信。此示例基于入门指南。双工协定以一对接口形式定义：一个从客户端到服务的主接口和一个从服务到客户端的回调接口。在本示例中，ICalculatorDuplex 接口允许客户端执行数学运算，通过会话计算结果。服务在 ICalculatorDuplexCallback 接口上返回结果。双工协定需要会话，因为必须建立上下文才能将客户端和服务之间发送的一组消息关联在一起。

注意

本主题的最后介绍了此示例的设置过程和生成说明。

在此示例中，客户端是一个控制台应用程序 (.exe)，服务是由 Internet 信息服务 (IIS) 承载的。双工协定定义如下：

[ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples", SessionMode=SessionMode.Required,
                 CallbackContract=typeof(ICalculatorDuplexCallback))]
public interface ICalculatorDuplex
{
    [OperationContract(IsOneWay = true)]
    void Clear();
    [OperationContract(IsOneWay = true)]
    void AddTo(double n);
    [OperationContract(IsOneWay = true)]
    void SubtractFrom(double n);
    [OperationContract(IsOneWay = true)]
    void MultiplyBy(double n);
    [OperationContract(IsOneWay = true)]
    void DivideBy(double n);
}

public interface ICalculatorDuplexCallback
{
    [OperationContract(IsOneWay = true)]
    void Result(double result);
    [OperationContract(IsOneWay = true)]
    void Equation(string eqn);
}

CalculatorService 类实现 ICalculatorDuplex 主接口。服务使用 PerSession 实例模式来维护每个会话的结果。名为 Callback 的私有属性用于访问指向客户端的回调通道。服务使用该回调通过回调接口将消息发送回客户端。

[ServiceBehavior(InstanceContextMode = InstanceContextMode.PerSession)]
public class CalculatorService : ICalculatorDuplex
{
    double result = 0.0D;
    string equation;

    public CalculatorService()
    {
        equation = result.ToString();
    }

    public void Clear()
    {
        Callback.Equation($"{equation} = {result}");
        equation = result.ToString();
    }

    public void AddTo(double n)
    {
        result += n;
        equation += $" + {n}";
        Callback.Result(result);
    }

    //...

    ICalculatorDuplexCallback Callback
    {
        get
        {
            return OperationContext.Current.GetCallbackChannel<ICalculatorDuplexCallback>();
        }
    }
}

客户端必须提供一个实现双工协定回调接口的类，以便从服务接收消息。该示例中，定义 CallbackHandler 类以实现 ICalculatorDuplexCallback 接口。

public class CallbackHandler : ICalculatorDuplexCallback
{
   public void Result(double result)
   {
      Console.WriteLine("Result({0})", result);
   }

   public void Equation(string equation)
   {
      Console.WriteLine("Equation({0}", equation);
   }
}

针对双工协定生成的代理需要在构造时提供一个 InstanceContext。此 InstanceContext 用作实现回调接口并处理从服务发送回的消息的对象所在的位置。 InstanceContext 是用 CallbackHandler 类的实例构造的。此对象处理通过回调接口从服务发送到客户端的消息。

// Construct InstanceContext to handle messages on callback interface.
InstanceContext instanceContext = new InstanceContext(new CallbackHandler());

// Create a client.
CalculatorDuplexClient client = new CalculatorDuplexClient(instanceContext);

Console.WriteLine("Press <ENTER> to terminate client once the output is displayed.");
Console.WriteLine();

// Call the AddTo service operation.
double value = 100.00D;
client.AddTo(value);

// Call the SubtractFrom service operation.
value = 50.00D;
client.SubtractFrom(value);

// Call the MultiplyBy service operation.
value = 17.65D;
client.MultiplyBy(value);

// Call the DivideBy service operation.
value = 2.00D;
client.DivideBy(value);

// Complete equation.
client.Clear();

Console.ReadLine();

//Closing the client gracefully closes the connection and cleans up resources.
client.Close();

已将配置修改为提供同时支持会话通信和双工通信的绑定。 wsDualHttpBinding 支持会话通信，并通过提供双 HTTP 连接（一个连接对应于一个方向）来允许进行双工通信。在服务上，配置中的唯一区别是所用的绑定。在客户端上，必须配置一个服务器可用来连接客户端的地址，如下面的示例配置所示。

<client>
  <endpoint name=""
            address="http://localhost/servicemodelsamples/service.svc"
            binding="wsDualHttpBinding"
            bindingConfiguration="DuplexBinding"
            contract="Microsoft.ServiceModel.Samples.ICalculatorDuplex" />
</client>

<bindings>
  <!-- Configure a binding that support duplex communication. -->
  <wsDualHttpBinding>
    <binding name="DuplexBinding"
             clientBaseAddress="http://localhost:8000/myClient/">
    </binding>
  </wsDualHttpBinding>
</bindings>

当运行示例时，从服务发送的回调接口上，可以看到返回到客户端的消息。显示每个中间结果，最后在所有操作完成时显示整个公式。按 Enter 可关闭客户端。

设置、生成和运行示例

请确保已执行 Windows Communication Foundation 示例的一次性安装过程。
要生成 C#、C++ 或 Visual Basic .NET 版本的解决方案，请按照生成 Windows Communication Foundation 示例中的说明进行操作。
要使用单机配置或跨计算机配置来运行示例，请按照运行 Windows Communication Foundation 示例中的说明进行操作。

重要

用跨计算机配置运行客户端时，确保用适当的计算机名称替换 <client> 元素的 <endpoint> 的 address 属性中的“localhost”和 <wsDualHttpBinding> 元素的 <> 元素的 clientBaseAddress 属性中的“localhost”，如下所示：
```
<client>
    <endpoint name = ""
    address="http://service_machine_name/servicemodelsamples/service.svc"
    ... />
</client>
...
<wsDualHttpBinding>
    <binding name="DuplexBinding" clientBaseAddress="http://client_machine_name:8000/myClient/">
    </binding>
</wsDualHttpBinding>
```

双工

设置、生成和运行示例

其他资源