1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="BodyWriter" FullName="System.ServiceModel.Channels.BodyWriter">
<TypeSignature Language="C#" Value="public abstract class BodyWriter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit BodyWriter extends System.Object" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>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 <see cref="T:System.ServiceModel.Channels.BodyWriter" /> to the <see cref="T:System.ServiceModel.Channels.Message" />. A message calls the class derived from <see cref="T:System.ServiceModel.Channels.BodyWriter" /> whenever it requires the body to be written using an <see cref="T:System.Xml.XmlWriter" />. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents the writer of the message body.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected BodyWriter (bool isBuffered);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(bool isBuffered) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="isBuffered" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If <paramref name="isBuffered" /> is false then the message calls the write method once and buffers the contents. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ServiceModel.Channels.BodyWriter" /> class that explicitly indicates whether to buffer.</para>
</summary>
<param name="isBuffered">
<attribution license="cc4" from="Microsoft" modified="false" />true if the body writer can be called multiple times; otherwise false.</param>
</Docs>
</Member>
<Member MemberName="CreateBufferedCopy">
<MemberSignature Language="C#" Value="public System.ServiceModel.Channels.BodyWriter CreateBufferedCopy (int maxBufferSize);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.ServiceModel.Channels.BodyWriter CreateBufferedCopy(int32 maxBufferSize) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.BodyWriter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="maxBufferSize" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If <see cref="P:System.ServiceModel.Channels.BodyWriter.IsBuffered" /> is true then the <see cref="T:System.ServiceModel.Channels.BodyWriter" /> object is returned. If <see cref="P:System.ServiceModel.Channels.BodyWriter.IsBuffered" /> is false then the contents of the <see cref="T:System.ServiceModel.Channels.BodyWriter" /> up to <paramref name="maxBufferSize" /> is returned. This also calls <see cref="M:System.ServiceModel.Channels.BodyWriter.OnCreateBufferedCopy(System.Int32)" /> as an extensibility point.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a buffered copy of the body.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.ServiceModel.Channels.BodyWriter" /> that contains a copy of this object.</para>
</returns>
<param name="maxBufferSize">
<attribution license="cc4" from="Microsoft" modified="false" />The maximum size of the buffer for the body.</param>
</Docs>
</Member>
<Member MemberName="IsBuffered">
<MemberSignature Language="C#" Value="public bool IsBuffered { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsBuffered" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If <paramref name="isBuffered" /> is false then the message calls the write method once and buffers the contents. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates whether the write method can be called multiple times.</para>
</summary>
</Docs>
</Member>
<Member MemberName="OnCreateBufferedCopy">
<MemberSignature Language="C#" Value="protected virtual System.ServiceModel.Channels.BodyWriter OnCreateBufferedCopy (int maxBufferSize);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.ServiceModel.Channels.BodyWriter OnCreateBufferedCopy(int32 maxBufferSize) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.Channels.BodyWriter</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="maxBufferSize" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A class derived from <see cref="T:System.ServiceModel.Channels.BodyWriter" /> can override this method to create a buffered copy of the <see cref="T:System.ServiceModel.Channels.BodyWriter" />. But the default implementation of <see cref="M:System.ServiceModel.Channels.BodyWriter.WriteBodyContents(System.Xml.XmlDictionaryWriter)" /> calls <see cref="M:System.ServiceModel.Channels.BodyWriter.OnWriteBodyContents(System.Xml.XmlDictionaryWriter)" />, so overriding just <see cref="M:System.ServiceModel.Channels.BodyWriter.OnWriteBodyContents(System.Xml.XmlDictionaryWriter)" /> should be easier and work for most scenarios.</para>
<para>Note that the <see cref="T:System.ServiceModel.Channels.BodyWriter" /> returned must be buffered, that is <see cref="P:System.ServiceModel.Channels.BodyWriter.IsBuffered" /> must be true.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides an extensibility point when the body contents are written.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.ServiceModel.Channels.BodyWriter" /> with the specified maximum buffer size.</para>
</returns>
<param name="maxBufferSize">
<attribution license="cc4" from="Microsoft" modified="false" />The maximum size of the buffer for the body.</param>
</Docs>
</Member>
<Member MemberName="OnWriteBodyContents">
<MemberSignature Language="C#" Value="protected abstract void OnWriteBodyContents (System.Xml.XmlDictionaryWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnWriteBodyContents(class System.Xml.XmlDictionaryWriter writer) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Xml.XmlDictionaryWriter" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method must be implemented by classes derived from <see cref="T:System.ServiceModel.Channels.BodyWriter" />. This is the key method that writes the body. If the <see cref="T:System.ServiceModel.Channels.BodyWriter" /> is buffered then this method is called only once.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When implemented, provides an extensibility point when the body contents are written.</para>
</summary>
<param name="writer">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Xml.XmlDictionaryWriter" /> used to write out the message body.</param>
</Docs>
</Member>
<Member MemberName="WriteBodyContents">
<MemberSignature Language="C#" Value="public void WriteBodyContents (System.Xml.XmlDictionaryWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteBodyContents(class System.Xml.XmlDictionaryWriter writer) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Xml.XmlDictionaryWriter" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The default implementation of <see cref="M:System.ServiceModel.Channels.BodyWriter.WriteBodyContents(System.Xml.XmlDictionaryWriter)" /> calls <see cref="M:System.ServiceModel.Channels.BodyWriter.OnWriteBodyContents(System.Xml.XmlDictionaryWriter)" />, so overriding <see cref="M:System.ServiceModel.Channels.BodyWriter.OnWriteBodyContents(System.Xml.XmlDictionaryWriter)" /> provides the best point of extension.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Writes out the contents of the message body.</para>
</summary>
<param name="writer">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Xml.XmlDictionaryWriter" /> used to write out the message body.</param>
</Docs>
</Member>
</Members>
</Type>
|