File: ServicePointManager.xml

package info (click to toggle)
monodoc 1.1.18-1
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 58,432 kB
  • ctags: 4,991
  • sloc: xml: 718,392; cs: 38,337; sh: 3,172; perl: 554; makefile: 303
file content (328 lines) | stat: -rwxr-xr-x 18,159 bytes parent folder | download
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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
<Type Name="ServicePointManager" FullName="System.Net.ServicePointManager" FullNameSP="System_Net_ServicePointManager" Maintainer="ecma">
  <TypeSignature Language="ILASM" Value=".class public ServicePointManager extends System.Object" />
  <TypeSignature Language="C#" Value="public class ServicePointManager" />
  <MemberOfLibrary>Networking</MemberOfLibrary>
  <AssemblyInfo>
    <AssemblyName>System</AssemblyName>
    <AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
    <AssemblyVersion>1.0.x.x</AssemblyVersion>
    <AssemblyCulture>none</AssemblyCulture>
    <Attributes>
      <Attribute>
        <AttributeName>CLSCompliantAttribute(true)</AttributeName>
        <Excluded>0</Excluded>
      </Attribute>
    </Attributes>
  </AssemblyInfo>
  <ThreadingSafetyStatement>The public static fields exposed in ServicePointManager are not thread safe.  Changing one of these values in one thread will change the value for any other thread subsequently accessing the field.</ThreadingSafetyStatement>
  <Docs>
    <summary>
      <para> Manages <see cref="T:System.Net.ServicePoint" /> instances.</para>
    </summary>
    <remarks>
      <para>
        <see cref="T:System.Net.ServicePointManager" /> creates, maintains,
 and deletes <see cref="T:System.Net.ServicePoint" /> instances. </para>
      <para> When an application requests a connection to an Internet resource through
 the <see cref="T:System.Net.ServicePointManager" />, the <see cref="T:System.Net.ServicePointManager" />
 returns a <see cref="T:System.Net.ServicePoint" /> instance containing
 connection information for the host identified by
 the Uniform Resource Identifier (URI) of the resource. If there is an existing <see cref="T:System.Net.ServicePoint" /> for that host, the
<see cref="T:System.Net.ServicePointManager" /> 
returns the existing <see cref="T:System.Net.ServicePoint" />, otherwise the <see cref="T:System.Net.ServicePointManager" /> creates a new <see cref="T:System.Net.ServicePoint" />
instance. </para>
    </remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Members>
    <Member MemberName="DefaultNonPersistentConnectionLimit">
      <MemberSignature Language="ILASM" Value=".field public static literal int32 DefaultNonPersistentConnectionLimit = 4" />
      <MemberSignature Language="C#" Value="public const int DefaultNonPersistentConnectionLimit = 4;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>4</MemberValue>
      <Docs>
        <summary>
          <para> The default number of non-persistent connections allowed on a <see cref="T:System.Net.ServicePoint" /> .
   </para>
        </summary>
        <remarks>
          <para>This field is read-only.</para>
          <para>The value of this field is
      4.</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="DefaultPersistentConnectionLimit">
      <MemberSignature Language="ILASM" Value=".field public static literal int32 DefaultPersistentConnectionLimit = 2" />
      <MemberSignature Language="C#" Value="public const int DefaultPersistentConnectionLimit = 2;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>2</MemberValue>
      <Docs>
        <summary>
          <para> The default number of persistent connections allowed on a <see cref="T:System.Net.ServicePoint" /> .
   </para>
        </summary>
        <remarks>
          <para>This field is read-only.</para>
          <para>The value of this field is
      2.</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="FindServicePoint">
      <MemberSignature Language="ILASM" Value=".method public hidebysig static class System.Net.ServicePoint FindServicePoint(class System.Uri address)" />
      <MemberSignature Language="C#" Value="public static ServicePoint FindServicePoint(Uri address);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.ServicePoint</ReturnType>
      </ReturnValue>
      <Parameters>
		<Parameter Name="address" Type="System.Uri" />
	</Parameters>
      <Docs>
        <summary>
          <para>Finds an existing <see cref="T:System.Net.ServicePoint" /> or creates a new <see cref="T:System.Net.ServicePoint" /> to connect to the specified host.</para>
        </summary>
        <param name="address">A <see cref="T:System.Uri" /> containing the Internet host to contact.</param>
        <returns>
          <para>A <see cref="T:System.Net.ServicePoint" /> that connects to the host identified in
<paramref name="address" /> 
.</para>
        </returns>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="address " />is <see langword="null" />.</exception>
        <exception cref="T:System.InvalidOperationException">The maximum number of service points defined in <see cref="P:System.Net.ServicePointManager.MaxServicePoints" /> has been reached and there is no service point that connects to the specified host.</exception>
        <remarks>
          <para>This method is identical to <see cref="M:System.Net.ServicePointManager.FindServicePoint(System.Uri)" />(<paramref name="address" />, <see cref="M:System.Net.GlobalProxySelection.GetEmptyWebProxy" />).</para>
          <para> If no <see cref="T:System.Net.ServicePoint" /> exists for the host named in <paramref name="address" /> , the <see cref="T:System.Net.ServicePointManager" /> attempts to
create one.</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="FindServicePoint">
      <MemberSignature Language="ILASM" Value=".method public hidebysig static class System.Net.ServicePoint FindServicePoint(string uriString, class System.Net.IWebProxy proxy)" />
      <MemberSignature Language="C#" Value="public static ServicePoint FindServicePoint(string uriString, IWebProxy proxy);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.ServicePoint</ReturnType>
      </ReturnValue>
      <Parameters>
		<Parameter Name="uriString" Type="System.String" />
		<Parameter Name="proxy" Type="System.Net.IWebProxy" />
	</Parameters>
      <Docs>
        <summary>
          <para>Finds an existing <see cref="T:System.Net.ServicePoint" /> or creates a new <see cref="T:System.Net.ServicePoint" /> to connect to the specified host.</para>
        </summary>
        <param name="uriString">A <see cref="T:System.String" /> containing a URI that names the host to contact.</param>
        <param name="proxy">A <see cref="T:System.Net.IWebProxy" /> that represents a proxy server to access.</param>
        <returns>
          <para>A <see cref="T:System.Net.ServicePoint" /> that connects to the host identified in
<paramref name="uriString" /> 
.</para>
        </returns>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="uriString" /> is <see langword="null" />.</exception>
        <exception cref="T:System.UriFormatException">The URI specified in <paramref name="uriString" /> is in an invalid form.</exception>
        <exception cref="T:System.InvalidOperationException">The maximum number of service points defined in <see cref="P:System.Net.ServicePointManager.MaxServicePoints" /> has been reached and there is no service point that connects to the specified host.</exception>
        <remarks>
          <para>This method is identical to <see cref="M:System.Net.ServicePointManager.FindServicePoint(System.Uri)" />(new <see cref="T:System.Uri" />(<paramref name="uriString" />),
<paramref name="proxy" />).</para>
          <para>If no <see cref="T:System.Net.ServicePoint" /> exists for the host named in <paramref name="uriString" />, the
<see cref="T:System.Net.ServicePointManager" /> attempts to create one.</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="FindServicePoint">
      <MemberSignature Language="ILASM" Value=".method public hidebysig static class System.Net.ServicePoint FindServicePoint(class System.Uri address, class System.Net.IWebProxy proxy)" />
      <MemberSignature Language="C#" Value="public static ServicePoint FindServicePoint(Uri address, IWebProxy proxy);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.ServicePoint</ReturnType>
      </ReturnValue>
      <Parameters>
		<Parameter Name="address" Type="System.Uri" />
		<Parameter Name="proxy" Type="System.Net.IWebProxy" />
	</Parameters>
      <Docs>
        <summary>
          <para>Finds an existing <see cref="T:System.Net.ServicePoint" /> or creates a new <see cref="T:System.Net.ServicePoint" /> to connect to the specified host.</para>
        </summary>
        <param name="address">A <see cref="T:System.Uri" /> instance containing the address of the Internet resource to contact.</param>
        <param name="proxy">A <see cref="T:System.Net.IWebProxy" /> that represents a proxy server to access.</param>
        <returns>
          <para>A <see cref="T:System.Net.ServicePoint" /> that connects to the host identified in
<paramref name="address" /> 
.</para>
        </returns>
        <exception cref="T:System.ArgumentNullException">
          <paramref name="address " />is <see langword="null" />.</exception>
        <exception cref="T:System.InvalidOperationException">The maximum number of service points defined in <see cref="P:System.Net.ServicePointManager.MaxServicePoints" /> has been reached and there is no service point that connects to the specified host.</exception>
        <remarks>
          <para> If no <see cref="T:System.Net.ServicePoint" /> exists for the <see cref="P:System.Uri.Host" /> specified in <paramref name="address" /> , the <see cref="T:System.Net.ServicePointManager" /> attempts to create one.</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="MaxServicePoints">
      <MemberSignature Language="ILASM" Value=".property int32 MaxServicePoints { public hidebysig static specialname int32 get_MaxServicePoints() public hidebysig static specialname void set_MaxServicePoints(int32 value) }" />
      <MemberSignature Language="C#" Value="public static int MaxServicePoints { get; set; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>0</MemberValue>
      <Docs>
        <summary>
          <para>Gets or sets the maximum number of <see cref="T:System.Net.ServicePoint" /> instances managed by this class at any
 time.</para>
        </summary>
        <value>
          <para>A <see cref="T:System.Int32" /> containing the maximum number of <see cref="T:System.Net.ServicePoint" /> instances to maintain.</para>
        </value>
        <exception cref="T:System.ArgumentOutOfRangeException">The value specified for a set operation is less than zero or greater than <see cref="F:System.Int32.MaxValue" qualify="true" /></exception>
        <remarks>
          <para>If this property is set to a value that is less than the
 number of <see cref="T:System.Net.ServicePoint" /> instances currently in
 existence, the <see cref="T:System.Net.ServicePointManager" />
 deletes the
 <see cref="T:System.Net.ServicePoint" /> instances with the longest idle times.
 If the number of <see cref="T:System.Net.ServicePoint" /> instances with active
 connections is greater than the value of
 <see cref="P:System.Net.ServicePointManager.MaxServicePoints" />, the <see cref="T:System.Net.ServicePointManager" /> 
 deletes <see cref="T:System.Net.ServicePoint" />
 instances as they become idle. </para>
          <para>
            <block subset="none" type="note">The default value
 of the <see cref="P:System.Net.ServicePointManager.MaxServicePoints" /> property is 0, which indicates
 there is no limit to the number of <see cref="T:System.Net.ServicePoint" /> instances.</block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="DefaultConnectionLimit">
      <MemberSignature Language="ILASM" Value=".property int32 DefaultConnectionLimit { public hidebysig static specialname int32 get_DefaultConnectionLimit() public hidebysig static specialname void set_DefaultConnectionLimit(int32 value) }" />
      <MemberSignature Language="C#" Value="public static int DefaultConnectionLimit { get; set; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>2</MemberValue>
      <Docs>
        <summary>
          <para>Gets or sets the maximum number of concurrent connections allowed by a
   <see cref="T:System.Net.ServicePoint" /> instance.</para>
        </summary>
        <value>
          <para>A <see cref="T:System.Int32" /> containing the maximum number of concurrent connections allowed by a <see cref="T:System.Net.ServicePoint" /> instance.</para>
        </value>
        <exception cref="T:System.ArgumentOutOfRangeException">The value specified for a set operation is less than or equal to zero.</exception>
        <remarks>
          <para>The <see cref="P:System.Net.ServicePointManager.DefaultConnectionLimit" /> property sets the default maximum number of concurrent
   connections that the <see cref="T:System.Net.ServicePointManager" /> assigns to the <see cref="P:System.Net.ServicePoint.ConnectionLimit" /> property
   when creating <see cref="T:System.Net.ServicePoint" /> instances.</para>
          <para>
            <block subset="none" type="note">Changing the <see cref="P:System.Net.ServicePointManager.DefaultConnectionLimit" /> property has no effect on existing <see cref="T:System.Net.ServicePoint" />
instances; it affects only <see cref="T:System.Net.ServicePoint" /> instances that
are initialized after the change.</block>
          </para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
    <Member MemberName="MaxServicePointIdleTime">
      <MemberSignature Language="ILASM" Value=".property int32 MaxServicePointIdleTime { public hidebysig static specialname int32 get_MaxServicePointIdleTime() public hidebysig static specialname void set_MaxServicePointIdleTime(int32 value) }" />
      <MemberSignature Language="C#" Value="public static int MaxServicePointIdleTime { get; set; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <MemberValue>900000</MemberValue>
      <Docs>
        <summary>
          <para> Gets or sets the maximum amount of time a <see cref="T:System.Net.ServicePoint" /> instance can be idle, 
   after which resources allocated
   to the service point can be released.</para>
        </summary>
        <value>
          <para>A <see cref="T:System.Int32" /> containing the maximum idle time, in milliseconds, of a <see cref="T:System.Net.ServicePoint" /> instance.</para>
        </value>
        <exception cref="T:System.ArgumentOutOfRangeException">The value specified for a set operation is less than <see cref="F:System.Threading.Timeout.Infinite" /> or greater than <see cref="F:System.Int32.MaxValue" qualify="true" /></exception>
        <remarks>
          <para> A <see cref="T:System.Net.ServicePoint" />
is idle when the list of
connections associated with the <see cref="T:System.Net.ServicePoint" /> is empty.</para>
          <para>The <see cref="P:System.Net.ServicePointManager.MaxServicePointIdleTime" />
property holds the value for the maximum idle time for service points. When a <see cref="T:System.Net.ServicePoint" /> instance is created,
this value is assigned to its <see cref="P:System.Net.ServicePoint.MaxIdleTime" /> property. Changes to the value
of this property affect only <see cref="T:System.Net.ServicePoint" /> instances that are initialized after this property
is changed.</para>
          <para>After a <see cref="T:System.Net.ServicePoint" /> has been idle for the time
specified in <see cref="P:System.Net.ServicePoint.MaxIdleTime" /> , it is
released by the service point manager, and
any resources allocated
for it are freed.</para>
          <para>The default value of this property is
   implementation defined.</para>
        </remarks>
      </Docs>
      <Excluded>0</Excluded>
    </Member>
  <Member MemberName="CertificatePolicy">
      <MemberSignature Language="C#" Value="public static System.Net.ICertificatePolicy CertificatePolicy { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.ICertificatePolicy</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  <Member MemberName="CheckCertificateRevocationList">
      <MemberSignature Language="C#" Value="public static bool CheckCertificateRevocationList { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  <Member MemberName="SecurityProtocol">
      <MemberSignature Language="C#" Value="public static System.Net.SecurityProtocolType SecurityProtocol { set; get; }" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Net.SecurityProtocolType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added.</summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
  <TypeExcluded>0</TypeExcluded>
</Type>