SoapDocumentMethodAttribute.OneWay プロパティ

.NET Framework クラス ライブラリ リファレンス

SoapDocumentMethodAttribute.OneWay プロパティ

Web サーバーが XML Web サービス メソッドの処理を完了するまで XML Web サービス クライアントが待機するかどうかを示す値を取得または設定します。

名前空間: System.Web.Services.Protocols
アセンブリ: System.Web.Services (system.web.services.dll 内)
構文

Visual Basic (宣言)

Public Property OneWay As
 Boolean

Visual Basic (使用法)

Dim instance As SoapDocumentMethodAttribute
Dim value As Boolean

value = instance.OneWay

instance.OneWay = value

C#

public bool OneWay { get;
 set; }

C++

public:
property bool OneWay {
    bool get ();
    void set (bool value);
}

J#

/** @property */
public boolean get_OneWay ()

/** @property */
public void set_OneWay (boolean value)

JScript

public function get OneWay
 () : boolean

public function set OneWay
 (value : boolean)

プロパティ値
Web サーバーが XML Web サービス メソッドの処理を完了するまで XML Web サービス クライアントが待機しない場合は true。既定値は false です。

解説

XML Web サービス メソッドの OneWay プロパティが true に設定されている場合、その XML Web サービスのクライアントは、Web サーバーが XML Web サービス メソッドの処理を完了するまで待機する必要はありません。この場合、Web サーバーは SoapServerMessage を逆シリアル化した直後から XML Web サービス メソッドが呼び出されるまでの間に、HTTP 202 ステータス コードを返します。HTTP 202 ステータス コードは、Web サーバーがメッセージの処理を開始したことをクライアントに通知します。このため、XML Web サービス クライアントは Web サーバーがメッセージを正常に処理したことを示す受信確認は受信しません。

一方向のメソッドは、戻り値も out パラメータも持つことはできません。

使用している .NET Framework Version 1.0 XML Web サービスのメソッドに SoapRpcMethodAttribute 属性または SoapDocumentMethodAttribute 属性が適用されており、OneWay プロパティが true に設定されている場合は、静的な Current プロパティを使用して HttpContext にアクセスしないでください。HttpContext にアクセスするには、XML Web サービスのメソッドを実装するクラスを WebService から派生し、Context プロパティにアクセスします。

使用例

次の例で示す XML Web サービス メソッドは、その処理が完了するまでクライアントが待機することを要求しません。つまり、この例では OneWay プロパティが true に設定されています。

Visual Basic

<%@ WebService Language="VB" Class="Stats"
 %>
 
Imports System.Web.Services
Imports System.Web.Services.Protocols

Public Class Stats
    Inherits WebService
        
    <SoapDocumentMethod(OneWay := True), _
    WebMethod(Description := "Starts nightly statistics batch
 process.")> _
    Public Sub _
        StartStatsCrunch()
        
        ' Begin nightly statistics crunching process.
        ' A one-way method cannot have return values.
    End Sub
End Class

C#

<%@ WebService Language="C#" Class="Stats" %>
 
 using System.Web.Services;
 using System.Web.Services.Protocols;
 
 public class Stats: WebService {
 
      [ SoapDocumentMethod(OneWay=true) ]
      [ WebMethod(Description="Starts nightly statistics batch process.")
 ]
      public void StartStatsCrunch() {
         // Begin nightly statistics crunching process.
         // A one-way method cannot have return values.
      }      
 
 }

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
SoapDocumentMethodAttribute クラス
SoapDocumentMethodAttribute メンバ
System.Web.Services.Protocols 名前空間
SoapServerMessage