SoapClientMessage.OneWay Property

Definition

Namespace:

System.Web.Services.Protocols

Assembly:

System.Web.Services.dll

Gets a value indicating whether the client waits for the server to finish processing an XML Web service method.

public:
 virtual property bool OneWay { bool get(); };

public override bool OneWay { get; }

member this.OneWay : bool

Public Overrides ReadOnly Property OneWay As Boolean

Property Value

Boolean

true if the client does not wait for the server to completely process a method.

Examples

The following code fragment is part of a SOAP extension that logs the SOAP messages sent and received by an XML Web service client. This particular fragment outputs to that log file a phrase stating the XML Web service method is one-way, when the OneWay property is true.

newStream->Position = 0;
FileStream^ myFileStream = gcnew FileStream( filename, FileMode::Append,
   FileAccess::Write );
StreamWriter^ myStreamWriter = gcnew StreamWriter( myFileStream );
myStreamWriter->WriteLine(
   "================================== Request at {0}", DateTime::Now );

// Print to the log file the request header field for SoapAction header.
myStreamWriter->WriteLine( "The SoapAction Http request header field is: " );
myStreamWriter->WriteLine( "\t{0}", message->Action );

// Print to the log file the type of the client that invoked 
// the XML Web service method.
myStreamWriter->WriteLine( "The type of the client is: " );
if ( (message->Client->GetType())->Equals( typeid<MathSvc^> ) )
{
   myStreamWriter->WriteLine( "\tMathSvc" );
}

// Print to the log file the method invoked by the client.
myStreamWriter->WriteLine(
   "The method that has been invoked by the client is:" );
myStreamWriter->WriteLine( "\t{0}", message->MethodInfo->Name );

// Print to the log file if the method invoked is OneWay.
if ( message->OneWay )
{
   myStreamWriter->WriteLine(
      "The client doesn't wait for the server to finish processing" );
}
else
{
   myStreamWriter->WriteLine(
   "The client waits for the server to finish processing" );
}

// Print to the log file the URL of the site that provides 
// implementation of the method.
myStreamWriter->WriteLine(
   "The URL of the XML Web service method that has been requested is: " );
myStreamWriter->WriteLine( "\t{0}", message->Url );
myStreamWriter->WriteLine( "The contents of the SOAP envelope are: " );
myStreamWriter->Flush();

// Copy the contents of one stream to another. 
Copy( newStream, myFileStream );
myFileStream->Close();
newStream->Position = 0;

// Copy the contents of one stream to another. 
Copy( newStream, oldStream );

newStream.Position = 0;
FileStream myFileStream = new FileStream(filename, FileMode.Append,
   FileAccess.Write);
StreamWriter myStreamWriter = new StreamWriter(myFileStream);
myStreamWriter.WriteLine(
   "================================== Request at "
   + DateTime.Now);

// Print to the log file the request header field for SoapAction header.
myStreamWriter.WriteLine("The SoapAction Http request header field is: ");
myStreamWriter.WriteLine("\t" + message.Action);

// Print to the log file the type of the client that invoked
// the XML Web service method.
myStreamWriter.WriteLine("The type of the client is: ");
if((message.Client.GetType()).Equals(typeof(MathSvc)))
   myStreamWriter.WriteLine("\tMathSvc");

// Print to the log file the method invoked by the client.
myStreamWriter.WriteLine(
   "The method that has been invoked by the client is:");
myStreamWriter.WriteLine("\t" + message.MethodInfo.Name);

// Print to the log file if the method invoked is OneWay.
if(message.OneWay)
   myStreamWriter.WriteLine(
     "The client doesn't wait for the server to finish processing");
else
   myStreamWriter.WriteLine(
     "The client waits for the server to finish processing");

// Print to the log file the URL of the site that provides
// implementation of the method.
myStreamWriter.WriteLine(
   "The URL of the XML Web service method that has been requested is: ");
myStreamWriter.WriteLine("\t" + message.Url);
myStreamWriter.WriteLine("The contents of the SOAP envelope are: ");
myStreamWriter.Flush();

// Copy the contents of one stream to another.
Copy(newStream, myFileStream);
myFileStream.Close();
newStream.Position = 0;

// Copy the contents of one stream to another.
Copy(newStream, oldStream);

 newStream.Position = 0
 Dim myFileStream As New FileStream(filename, FileMode.Append, _
    FileAccess.Write)
 Dim myStreamWriter As New StreamWriter(myFileStream)
 myStreamWriter.WriteLine( _
    "================================== Request at " & DateTime.Now)

 ' Print to the log file the request header field for SoapAction header.
 myStreamWriter.WriteLine("The SoapAction Http request header field is: ")
 myStreamWriter.WriteLine(ControlChars.Tab & message.Action)

 ' Print to the log file the type of the client that invoked
 ' the XML Web service method.
 myStreamWriter.WriteLine("The type of the client is: ")
 If message.Client.GetType().Equals(GetType(MathSvc)) Then
    myStreamWriter.WriteLine(ControlChars.Tab & "MathSvc")
 End If

' Print to the log file the method invoked by the client.
 myStreamWriter.WriteLine( _
    "The method that has been invoked by the client is:")
 myStreamWriter.WriteLine(ControlChars.Tab & message.MethodInfo.Name)

 ' Print to the log file if the method invoked is OneWay.
 If message.OneWay Then
    myStreamWriter.WriteLine( _
       "The client doesn't wait for the server to finish processing")
 Else
    myStreamWriter.WriteLine( _
       "The client waits for the server to finish processing")
 End If 

 ' Print to the log file the URL of the site that provides 
 ' implementation of the method.
 myStreamWriter.WriteLine( _
    "The url of the XML Web service method that has been requested is: ")
 myStreamWriter.WriteLine(ControlChars.Tab & message.Url)
 myStreamWriter.WriteLine("The contents of the SOAP envelope are: ")
 myStreamWriter.Flush()

 ' Copy the contents of one stream to another. 
 Copy(newStream, myFileStream)
 myStreamWriter.Close()
 myFileStream.Close()
 newStream.Position = 0

 ' Copy the contents of one stream to another. 
 Copy(newStream, oldStream)

Remarks

A SoapDocumentMethodAttribute or SoapRpcMethodAttribute applied to an XML Web service method or XML Web service client can specify whether the XML Web service method is one way by setting the OneWay property of the attribute.

The OneWay property can be accessed during any SoapMessageStage.

See also

• OneWay