-
Notifications
You must be signed in to change notification settings - Fork 256
/
ClientPipelineOptions.xml
213 lines (213 loc) · 12.5 KB
/
ClientPipelineOptions.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
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<Type Name="ClientPipelineOptions" FullName="System.ClientModel.Primitives.ClientPipelineOptions">
<TypeSignature Language="C#" Value="public class ClientPipelineOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ClientPipelineOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.ClientModel.Primitives.ClientPipelineOptions" />
<TypeSignature Language="VB.NET" Value="Public Class ClientPipelineOptions" />
<TypeSignature Language="F#" Value="type ClientPipelineOptions = class" />
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Options that control the creation of a <see cref="T:System.ClientModel.Primitives.ClientPipeline" /> used
by a service client to send and receive HTTP messages.
Service clients must create a client-specific subtype of this class
to pass to their constructors to allow for service-specific options
with a client-wide scope.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ClientPipelineOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientPipelineOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddPolicy">
<MemberSignature Language="C#" Value="public void AddPolicy (System.ClientModel.Primitives.PipelinePolicy policy, System.ClientModel.Primitives.PipelinePosition position);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddPolicy(class System.ClientModel.Primitives.PipelinePolicy policy, valuetype System.ClientModel.Primitives.PipelinePosition position) cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientPipelineOptions.AddPolicy(System.ClientModel.Primitives.PipelinePolicy,System.ClientModel.Primitives.PipelinePosition)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddPolicy (policy As PipelinePolicy, position As PipelinePosition)" />
<MemberSignature Language="F#" Value="member this.AddPolicy : System.ClientModel.Primitives.PipelinePolicy * System.ClientModel.Primitives.PipelinePosition -> unit" Usage="clientPipelineOptions.AddPolicy (policy, position)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="policy" Type="System.ClientModel.Primitives.PipelinePolicy" />
<Parameter Name="position" Type="System.ClientModel.Primitives.PipelinePosition" />
</Parameters>
<Docs>
<param name="policy">The <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> to add to the
pipeline.</param>
<param name="position">The position of the policy in the pipeline.</param>
<summary>
Adds the provided <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> to the default
<see cref="T:System.ClientModel.Primitives.ClientPipeline" />.
</summary>
<remarks>
For a policy to run once per invocation of
<see cref="M:System.ClientModel.Primitives.ClientPipeline.Send(System.ClientModel.Primitives.PipelineMessage)" />, use
<see cref="F:System.ClientModel.Primitives.PipelinePosition.PerCall" />, which will insert the policy
before the pipeline's <see cref="P:System.ClientModel.Primitives.ClientPipelineOptions.RetryPolicy" />. For a policy to run
once per retry attempt, use <see cref="F:System.ClientModel.Primitives.PipelinePosition.PerTry" />, which
will insert the policy after the pipeline's <see cref="P:System.ClientModel.Primitives.ClientPipelineOptions.RetryPolicy" />.
To ensure that a policy runs after all other policies in the pipeline
have viewed the <see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> and before all
other policies view the <see cref="P:System.ClientModel.Primitives.PipelineMessage.Response" />, use
<see cref="F:System.ClientModel.Primitives.PipelinePosition.BeforeTransport" />. Changes made to
<see cref="P:System.ClientModel.Primitives.PipelineMessage.Request" /> by a before-transport policy will
not be visible to any logging policies that come before it in the
pipeline.
</remarks>
<exception cref="T:System.ArgumentException">Thrown when the provided policy
is <c>null</c>.</exception>
</Docs>
</Member>
<Member MemberName="AssertNotFrozen">
<MemberSignature Language="C#" Value="protected void AssertNotFrozen ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void AssertNotFrozen() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientPipelineOptions.AssertNotFrozen" />
<MemberSignature Language="VB.NET" Value="Protected Sub AssertNotFrozen ()" />
<MemberSignature Language="F#" Value="member this.AssertNotFrozen : unit -> unit" Usage="clientPipelineOptions.AssertNotFrozen " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Assert that <see cref="M:System.ClientModel.Primitives.ClientPipelineOptions.Freeze" /> has not been called on this
<see cref="T:System.ClientModel.Primitives.ClientPipelineOptions" /> instance.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">Thrown when an attempt is
made to change the state of this <see cref="T:System.ClientModel.Primitives.ClientPipelineOptions" />
instance after <see cref="M:System.ClientModel.Primitives.ClientPipelineOptions.Freeze" /> has been called.</exception>
</Docs>
</Member>
<Member MemberName="Freeze">
<MemberSignature Language="C#" Value="public virtual void Freeze ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Freeze() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ClientModel.Primitives.ClientPipelineOptions.Freeze" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Freeze ()" />
<MemberSignature Language="F#" Value="abstract member Freeze : unit -> unit
override this.Freeze : unit -> unit" Usage="clientPipelineOptions.Freeze " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Freeze this instance of <see cref="T:System.ClientModel.Primitives.ClientPipelineOptions" />. After
this method has been called, any attempt to set properties on the
instance or call methods that would change its state will throw
<see cref="T:System.InvalidOperationException" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NetworkTimeout">
<MemberSignature Language="C#" Value="public TimeSpan? NetworkTimeout { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.TimeSpan> NetworkTimeout" />
<MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientPipelineOptions.NetworkTimeout" />
<MemberSignature Language="VB.NET" Value="Public Property NetworkTimeout As Nullable(Of TimeSpan)" />
<MemberSignature Language="F#" Value="member this.NetworkTimeout : Nullable<TimeSpan> with get, set" Usage="System.ClientModel.Primitives.ClientPipelineOptions.NetworkTimeout" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.TimeSpan></ReturnType>
</ReturnValue>
<Docs>
<summary>
The timeout applied to an individual network operation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RetryPolicy">
<MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelinePolicy? RetryPolicy { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelinePolicy RetryPolicy" />
<MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientPipelineOptions.RetryPolicy" />
<MemberSignature Language="VB.NET" Value="Public Property RetryPolicy As PipelinePolicy" />
<MemberSignature Language="F#" Value="member this.RetryPolicy : System.ClientModel.Primitives.PipelinePolicy with get, set" Usage="System.ClientModel.Primitives.ClientPipelineOptions.RetryPolicy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ClientModel.Primitives.PipelinePolicy</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="T:System.ClientModel.Primitives.PipelinePolicy" /> to be used by the
<see cref="T:System.ClientModel.Primitives.ClientPipeline" /> for handling retry logic.
</summary>
<value>To be added.</value>
<remarks>
In most cases, this property will be set to an instance of
<see cref="T:System.ClientModel.Primitives.ClientRetryPolicy" />.
</remarks>
</Docs>
</Member>
<Member MemberName="Transport">
<MemberSignature Language="C#" Value="public System.ClientModel.Primitives.PipelineTransport? Transport { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ClientModel.Primitives.PipelineTransport Transport" />
<MemberSignature Language="DocId" Value="P:System.ClientModel.Primitives.ClientPipelineOptions.Transport" />
<MemberSignature Language="VB.NET" Value="Public Property Transport As PipelineTransport" />
<MemberSignature Language="F#" Value="member this.Transport : System.ClientModel.Primitives.PipelineTransport with get, set" Usage="System.ClientModel.Primitives.ClientPipelineOptions.Transport" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ClientModel</AssemblyName>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ClientModel.Primitives.PipelineTransport</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="T:System.ClientModel.Primitives.PipelineTransport" /> to be used by the
<see cref="T:System.ClientModel.Primitives.ClientPipeline" /> for sending and receiving HTTP messages.
</summary>
<value>To be added.</value>
<remarks>
In most cases, this property will be set to an instance of
<see cref="T:System.ClientModel.Primitives.HttpClientPipelineTransport" />.
</remarks>
</Docs>
</Member>
</Members>
</Type>