BodyWriter Class

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.1

Source:

BodyWriter.cs

Represents the writer of the message body.

C#

public abstract class BodyWriter

Inheritance

Object

BodyWriter

Derived

System.ServiceModel.Channels.StreamBodyWriter

System.ServiceModel.Security.WSTrustRequestBodyWriter

System.ServiceModel.Security.WSTrustResponseBodyWriter

Examples

The following example shows how to derive a class from BodyWriter. This override takes in an array of strings and writes them to a XmlDictionaryWriter.

C#

using System;
using System.Text;
using System.ServiceModel;
using System.ServiceModel.Channels;
using System.Xml;

namespace UEBodyWriter
{
    class MyBodyWriter : BodyWriter
    {
        const string textTag = "text";
        string[] bodySegment;

        public MyBodyWriter(string[] strData) : base(true)
        {
            int length = strData.Length;

            this.bodySegment = new string[length];
            for (int i = 0; i < length; i++)
            {
                this.bodySegment[i] = strData[i];
            }
        }

        protected override void OnWriteBodyContents(XmlDictionaryWriter writer)
        {
           writer.WriteStartElement(textTag);

           foreach (string str in bodySegment)
           {
               writer.WriteString(str);
           }

            writer.WriteEndElement();
        }
    }

    class Program
    {
        static void Main(string[] args)
        {
            string[] strings = {"Hello", "world"};
            MyBodyWriter bw = new MyBodyWriter(strings);

            StringBuilder strBuilder = new StringBuilder(10);
            XmlWriter writer = XmlWriter.Create(strBuilder);
            XmlDictionaryWriter dictionaryWriter = XmlDictionaryWriter.CreateDictionaryWriter(writer);

            bw.WriteBodyContents(dictionaryWriter);
            dictionaryWriter.Flush();
        }
    }
}

Remarks

A message consists of headers and a body. The headers are buffered and the body is streamed. Because the body is streamed, the user cannot pass the actual content of the body to a message. Instead the user must pass a class that knows how to write the body when asked to do so. This is done by passing a class derived from BodyWriter to the Message. A message calls the class derived from BodyWriter whenever it requires the body to be written using an XmlWriter.

Constructors

BodyWriter(Boolean)

Initializes a new instance of the BodyWriter class that explicitly indicates whether to buffer.

Properties

IsBuffered

Gets a value that indicates whether the write method can be called multiple times.

Methods

CreateBufferedCopy(Int32)	Creates a buffered copy of the body.
OnCreateBufferedCopy(Int32)	Provides an extensibility point when the body contents are written.
OnWriteBodyContents(XmlDictionaryWriter)	When implemented, provides an extensibility point when the body contents are written.
WriteBodyContents(XmlDictionaryWriter)	Writes out the contents of the message body.

Applies to