Export (0) Print
Expand All
0 out of 1 rated this helpful - Rate this topic

SoapClientMessage Class

Represents the data in a SOAP request sent or a SOAP response received by an XML Web service client at a specific SoapMessageStage. This class cannot be inherited.

System.Object
  System.Web.Services.Protocols.SoapMessage
    System.Web.Services.Protocols.SoapClientMessage

Namespace:  System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)
public sealed class SoapClientMessage : SoapMessage

The SoapClientMessage type exposes the following members.

  NameDescription
Public propertyActionGets the SOAPAction HTTP request header field for the SOAP request or SOAP response. (Overrides SoapMessage.Action.)
Public propertyClientGets an instance of the client proxy class, which derives from SoapHttpClientProtocol.
Public propertyContentEncodingGets or sets the contents of the Content-Encoding HTTP header. (Inherited from SoapMessage.)
Public propertyContentTypeGets or sets the HTTP Content-Type of the SOAP request or SOAP response. (Inherited from SoapMessage.)
Public propertyExceptionGets the SoapException from the call to the XML Web service method. (Inherited from SoapMessage.)
Public propertyHeadersA collection of the SOAP headers applied to the current SOAP request or SOAP response. (Inherited from SoapMessage.)
Public propertyMethodInfoGets a representation of the method prototype of the XML Web service method for which the SOAP request is intended. (Overrides SoapMessage.MethodInfo.)
Public propertyOneWayGets a value indicating whether the client waits for the server to finish processing an XML Web service method. (Overrides SoapMessage.OneWay.)
Public propertySoapVersionGets the version of the SOAP protocol used to communicate with the XML Web service. (Overrides SoapMessage.SoapVersion.)
Public propertyStageGets the SoapMessageStage of the SoapMessage. (Inherited from SoapMessage.)
Public propertyStreamGets the data representing the SOAP request or SOAP response in the form of a Stream. (Inherited from SoapMessage.)
Public propertyUrlGets the URL of the XML Web service. (Overrides SoapMessage.Url.)
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetInParameterValueGets the parameter passed into the XML Web service method at the specified index. (Inherited from SoapMessage.)
Public methodGetOutParameterValueGets the out parameter passed into the XML Web service method at the specified index. (Inherited from SoapMessage.)
Public methodGetReturnValueGets the return value of an XML Web service method. (Inherited from SoapMessage.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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 specific fragment processes the SoapClientMessage passed into the SoapExtension.ProcessMessage method of the SOAP extension by writing properties of the SoapClientMessage to the log file.


   // Process the SOAP message received and write to a log file. 
   public override void ProcessMessage(SoapMessage message) 
   {
      switch (message.Stage) 
      {
         case SoapMessageStage.BeforeSerialize:
            break;
         case SoapMessageStage.AfterSerialize:
            WriteOutput((SoapClientMessage)message);
            break;
         case SoapMessageStage.BeforeDeserialize:
            WriteInput((SoapClientMessage)message);
            break;
         case SoapMessageStage.AfterDeserialize:
            break;
         default:
            throw new Exception("invalid stage");
      }
   }

   // Write the contents of the outgoing SOAP message to the log file. 
   public void WriteOutput(SoapClientMessage message)
   {
// <Snippet5>
      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);
// </Snippet3>
   }

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.