SoapRpcMethodAttribute.OneWay プロパティとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

SoapRpcMethodAttribute.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 SoapRpcMethodAttribute
Dim value As Boolean

value = instance.OneWay

instance.OneWay = value

public bool OneWay { get;
 set; }

C++

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

/** @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。既定値は 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 プロパティにアクセスします。

使用例

OneWay プロパティを true に設定するコード例を次に示します。

Visual Basic

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

Public Class Stats
    Inherits WebService
        
    <SoapRpcMethod(OneWay := True), _
    WebMethod(Description := "Starts nightly stats batch process.")>
 _
    Public Sub _
        StartStatsCrunch()
        ' Begin a process that takes a long time to complete.
    End Sub
End Class

<%@ WebService Language="C#" Class="Stats" %>
 
 using System.Web.Services;
 using System.Web.Services.Protocols;
 
 public class Stats: WebService {
 
      [ SoapRpcMethod(OneWay=true) ]
      [ WebMethod(Description="Starts nightly stats batch process.") ]
      public void StartStatsCrunch() {
         // Begin a process that takes a long time to complete.
      }      
 
 }