揮発性キューによる通信

[アーティクル]
05/09/2023

Volatile サンプルでは、メッセージキュー (MSMQ) トランスポートで揮発性キューによる通信を実行する方法を示します。このサンプルでは、NetMsmqBinding を使用しています。この場合、サービスは自己ホスト型コンソールアプリケーションで、サービスがキュー内のメッセージを受信したかどうかを監視できます。

Note

このサンプルのセットアップ手順とビルド手順については、このトピックの最後を参照してください。

キュー通信では、クライアントはサービスとの通信にキューを使用します。厳密には、クライアントはメッセージをキューに送信します。サービスは、メッセージをキューから受信します。したがって、キューを使用する通信では、サービスとクライアントが同時に実行されていなくてもかまいません。

メッセージを保証なしで送信する場合、MSMQ ではメッセージ配信のみをベストエフォートで実行します。これとは異なり、正確に 1 回の保証がある場合は、MSMQ はメッセージの配信を確認し、配信できない場合にはメッセージが配信できないことをユーザーに通知します。

一部のシナリオでは、保証なしの揮発性メッセージをキューに送信する場合があります。この場合は、メッセージの損失より適切な時間での配信が重要です。揮発性メッセージは、キューマネージャがクラッシュすると失われます。したがって、キューマネージャがクラッシュした場合は、揮発性メッセージの保存に使用される非トランザクションキューは残りますが、メッセージそのものは失われます。メッセージはディスク上に保存されないためです。

注意

MSMQ を使用するトランザクションのスコープ内では、保証なしの揮発性メッセージを送信することはできません。また、揮発性メッセージを送信するには非トランザクションキューを作成する必要があります。

このサンプルのサービスコントラクトは IStockTicker です。これは、キューでの使用に最適な一方向サービスを定義します。

[ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples")]
public interface IStockTicker
{
    [OperationContract(IsOneWay = true)]
    void StockTick(string symbol, float price);
}

このサービス操作は、株価情報のシンボルと価格を表示します。次のサンプルコードを参照してください。

public class StockTickerService : IStockTicker
{
    public void StockTick(string symbol, float price)
    {
        Console.WriteLine("Stock Tick {0}:{1} ", symbol, price);
     }
     …
}

サービスは自己ホスト型です。 MSMQ トランスポートを使用する場合、使用するキューをあらかじめ作成しておく必要があります。手動で作成することもコードで作成することもできます。このサンプルでは、キューの存在を確認して、必要な場合は作成するためのコードがサービスに含まれています。キュー名は構成ファイルから読み込まれます。このベースアドレスは、ServiceModel メタデータユーティリティツール (Svcutil.exe) によってサービスのプロキシを生成するために使用されます。

// Host the service within this EXE console application.
public static void Main()
{
    // Get MSMQ queue name from app settings in configuration.
    string queueName = ConfigurationManager.AppSettings["queueName"];

    // Create the transacted MSMQ queue if necessary.
    if (!MessageQueue.Exists(queueName))
        MessageQueue.Create(queueName);

    // Create a ServiceHost for the StockTickerService type.
    using (ServiceHost serviceHost = new ServiceHost(typeof(StockTickerService)))
    {
        // Open the ServiceHost to create listeners and start listening for messages.
        serviceHost.Open();

        // The service can now be accessed.
        Console.WriteLine("The service is ready.");
        Console.WriteLine("Press <ENTER> to terminate service.");
        Console.WriteLine();
        Console.ReadLine();

        // Close the ServiceHost to shutdown the service.
        serviceHost.Close();
    }
}

MSMQ キュー名は、構成ファイルの appSettings セクションに指定されます。サービスのエンドポイントは、構成ファイルの system.serviceModel セクションで定義されます。このエンドポイントは netMsmqBinding バインディングを指定します。

注意

System.Messaging を使用してキューを作成する場合、キュー名では、ローカルコンピューターを表すのにドット (.) を使用し、パスの区切りにはバックスラッシュを使用します。 Windows Communication Foundation (WCF) エンドポイントアドレスでは、net.msmq: スキームを指定し、ローカルコンピューターを表すのに "localhost" を使用し、そのパスにはスラッシュを使用します。

メッセージの保証および持続性または揮発性についても、構成ファイルで指定します。

<appSettings>
  <!-- use appSetting to configure MSMQ queue name -->
  <add key="queueName" value=".\private$\ServiceModelSamplesVolatile" />
</appSettings>

<system.serviceModel>
  <services>
    <service name="Microsoft.ServiceModel.Samples.StockTickerService"
             behaviorConfiguration="CalculatorServiceBehavior">
    ...
      <!-- Define NetMsmqEndpoint -->
      <endpoint address="net.msmq://localhost/private/ServiceModelSamplesVolatile"
                binding="netMsmqBinding"
                bindingConfiguration="volatileBinding"
                contract="Microsoft.ServiceModel.Samples.IStockTicker" />
    ...
    </service>
  </services>

  <bindings>
    <netMsmqBinding>
      <binding name="volatileBinding"
             durable="false"
           exactlyOnce="false"/>
    </netMsmqBinding>
  </bindings>
  ...
</system.serviceModel>

サンプルでは非トランザクションキューを使用してキューに置かれたメッセージを送信するので、トランザクションメッセージをキューに送信することはできません。

// Create a client.
Random r = new Random(137);

StockTickerClient client = new StockTickerClient();

float price = 43.23F;
for (int i = 0; i < 10; i++)
{
    float increment = 0.01f * (r.Next(10));
    client.StockTick("zzz" + i, price + increment);
}

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

サンプルを実行すると、クライアントとサービスのアクティビティがサービスとクライアントの両方のコンソールウィンドウに表示されます。サービスがクライアントから受信したメッセージを表示できます。どちらかのコンソールで Enter キーを押すと、サービスとクライアントがどちらもシャットダウンされます。キューが使用されているので、クライアントとサービスが同時に実行されている必要はありません。クライアントを実行してシャットダウンした後にサービスを起動しても、サービスはメッセージを受信します。

The service is ready.
Press <ENTER> to terminate service.

Stock Tick zzz0:43.25
Stock Tick zzz1:43.23
Stock Tick zzz2:43.28
Stock Tick zzz3:43.3
Stock Tick zzz4:43.23
Stock Tick zzz5:43.25
Stock Tick zzz6:43.25
Stock Tick zzz7:43.24
Stock Tick zzz8:43.32
Stock Tick zzz9:43.3

サンプルをセットアップ、ビルド、および実行するには

Windows Communication Foundation サンプルの 1 回限りのセットアップの手順を実行したことを確認します。
ソリューションの C# 版または Visual Basic .NET 版をビルドするには、「 Building the Windows Communication Foundation Samples」の手順に従います。
単一または複数コンピューター構成でサンプルを実行するには、「Windows Communication Foundation サンプルの実行」の手順に従います。

NetMsmqBinding を使用する場合の既定では、トランスポートセキュリティが有効です。 MSMQ トランスポートセキュリティには、MsmqAuthenticationMode と MsmqProtectionLevel. の 2 つの関連プロパティがあります。既定では、認証モードは Windows に設定され、保護レベルは Sign に設定されます。 MSMQ の認証機能と署名機能を利用するには、ドメインに MSMQ があることと、MSMQ に関する Active Directory の統合オプションがインストールされていることが必要です。この条件を満たしていないコンピューターでこのサンプルを実行すると、エラーになります。

ワークグループに属しているコンピューターまたは Active Directory 統合のないコンピューターでこのサンプルを実行するには

ドメインに属していないコンピュータ、または Active Directory 統合がインストールされていないコンピュータを使用する場合は、トランスポートセキュリティをオフにします。オフにするには、認証モードと保護レベルを None にします。この構成コードの例を次に示します。

<system.serviceModel>
    <services>
      <service name="Microsoft.ServiceModel.Samples.StockTickerService"
               behaviorConfiguration="StockTickerServiceBehavior">
        <host>
          <baseAddresses>
            <add baseAddress="http://localhost:8000/ServiceModelSamples/service"/>
          </baseAddresses>
        </host>

        <!-- Define NetMsmqEndpoint -->
        <endpoint address="net.msmq://localhost/private/ServiceModelSamplesVolatile"
                  binding="netMsmqBinding"
                  bindingConfiguration="volatileBinding"
                  contract="Microsoft.ServiceModel.Samples.IStockTicker" />
        <!-- the mex endpoint is exposed at http://localhost:8000/ServiceModelSamples/service/mex -->
        <endpoint address="mex"
                  binding="mexHttpBinding"
                  contract="IMetadataExchange" />

      </service>
    </services>

    <bindings>
      <netMsmqBinding>
        <binding name="volatileBinding"
              durable="false"
              exactlyOnce="false">
          <security mode="None" />
        </binding>
      </netMsmqBinding>
    </bindings>

    <behaviors>
      <serviceBehaviors>
        <behavior name="StockTickerServiceBehavior">
          <serviceMetadata httpGetEnabled="True"/>
        </behavior>
      </serviceBehaviors>
    </behaviors>

  </system.serviceModel>

サーバーとクライアントの両方の構成を変更したことを確認してから、サンプルを実行します。

Note

security mode を None に設定することは、MsmqAuthenticationMode、MsmqProtectionLevel、および Message のセキュリティを None に設定することに相当します。

次の方法で共有

揮発性キューによる通信

サンプルをセットアップ、ビルド、および実行するには

ワークグループに属しているコンピューターまたは Active Directory 統合のないコンピューターでこのサンプルを実行するには

その他のリソース