-
Notifications
You must be signed in to change notification settings - Fork 255
/
IBufferManager.xml
98 lines (98 loc) · 5.36 KB
/
IBufferManager.xml
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
<Type Name="IBufferManager" FullName="Microsoft.Azure.Storage.IBufferManager">
<TypeSignature Language="C#" Value="public interface IBufferManager" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IBufferManager" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Storage.IBufferManager" />
<TypeSignature Language="VB.NET" Value="Public Interface IBufferManager" />
<TypeSignature Language="F#" Value="type IBufferManager = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Storage.Common</AssemblyName>
<AssemblyVersion>11.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
An interface that allows clients to provide a buffer manager to a given service client. This interface is patterned after
the <see href="http://msdn.microsoft.com/en-us/library/system.servicemodel.channels.buffermanager.aspx">System.ServiceModel.Channels.BufferManager</see> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="GetDefaultBufferSize">
<MemberSignature Language="C#" Value="public int GetDefaultBufferSize ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance int32 GetDefaultBufferSize() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Storage.IBufferManager.GetDefaultBufferSize" />
<MemberSignature Language="VB.NET" Value="Public Function GetDefaultBufferSize () As Integer" />
<MemberSignature Language="F#" Value="abstract member GetDefaultBufferSize : unit -> int" Usage="iBufferManager.GetDefaultBufferSize " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Storage.Common</AssemblyName>
<AssemblyVersion>11.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Gets the size, in bytes, of the buffers managed by the given pool. Note that the buffer manager must return buffers of the exact size requested by the client.
</summary>
<returns>The size, in bytes, of the buffers managed by the given pool.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReturnBuffer">
<MemberSignature Language="C#" Value="public void ReturnBuffer (byte[] buffer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void ReturnBuffer(unsigned int8[] buffer) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Storage.IBufferManager.ReturnBuffer(System.Byte[])" />
<MemberSignature Language="VB.NET" Value="Public Sub ReturnBuffer (buffer As Byte())" />
<MemberSignature Language="F#" Value="abstract member ReturnBuffer : byte[] -> unit" Usage="iBufferManager.ReturnBuffer buffer" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Storage.Common</AssemblyName>
<AssemblyVersion>11.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buffer" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="buffer">A byte array specifying the buffer to return to the pool.</param>
<summary>
Returns a buffer to the pool.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Buffer reference cannot be null.</exception>
<exception cref="T:System.ArgumentException">Length of buffer does not match the pool's buffer length property.</exception>
</Docs>
</Member>
<Member MemberName="TakeBuffer">
<MemberSignature Language="C#" Value="public byte[] TakeBuffer (int bufferSize);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance unsigned int8[] TakeBuffer(int32 bufferSize) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Storage.IBufferManager.TakeBuffer(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Function TakeBuffer (bufferSize As Integer) As Byte()" />
<MemberSignature Language="F#" Value="abstract member TakeBuffer : int -> byte[]" Usage="iBufferManager.TakeBuffer bufferSize" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Storage.Common</AssemblyName>
<AssemblyVersion>11.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="bufferSize" Type="System.Int32" />
</Parameters>
<Docs>
<param name="bufferSize">The size, in bytes, of the requested buffer.</param>
<summary>
Gets a buffer of the specified size or larger from the pool.
</summary>
<returns>A byte array that is the requested size of the buffer.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The value specified for <paramref name="bufferSize" /> cannot be less than zero.</exception>
</Docs>
</Member>
</Members>
</Type>