System.Net.WebRequest.cs

#region 程序集 System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089
// C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\System.dll
#endregion

using System.IO;
using System.Net.Cache;
using System.Net.Security;
using System.Runtime;
using System.Runtime.Serialization;
using System.Security.Principal;

namespace System.Net
{
    //
    // 摘要:
    //     发出对统一资源标识符 (URI) 的请求。这是一个 abstract 类。
    public abstract class WebRequest : MarshalByRefObject, ISerializable
    {
        //
        // 摘要:
        //     初始化 System.Net.WebRequest 类的新实例。
        protected WebRequest();
        //
        // 摘要:
        //     从 System.Runtime.Serialization.SerializationInfo 和 System.Runtime.Serialization.StreamingContext
        //     类的指定实例初始化 System.Net.WebRequest 类的新实例。
        //
        // 参数:
        //   serializationInfo:
        //     System.Runtime.Serialization.SerializationInfo，包含序列化新的 System.Net.WebRequest
        //     实例所需的信息。
        //
        //   streamingContext:
        //     System.Runtime.Serialization.StreamingContext，指示与新的 System.Net.WebRequest 实例关联的序列化流的源。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该构造函数时，尝试访问该构造函数。
        [TargetedPatchingOptOut( "Performance critical to inline this type of method across NGen image boundaries" )]
        protected WebRequest( SerializationInfo serializationInfo, StreamingContext streamingContext );

        //
        // 摘要:
        //     获取或设置此请求的默认缓存策略。
        //
        // 返回结果:
        //     一个 System.Net.Cache.HttpRequestCachePolicy，它指定当没有其他策略适用时对此请求有效的缓存策略。
        public static RequestCachePolicy DefaultCachePolicy { get; set; }
        //
        // 摘要:
        //     获取或设置全局 HTTP 代理。
        //
        // 返回结果:
        //     对 System.Net.WebRequest 实例的每一次调用所使用的 System.Net.IWebProxy。
        public static IWebProxy DefaultWebProxy { get; set; }
        //
        // 摘要:
        //     当在子类中被重写时，获取或设置要在此请求中使用的协议方法。
        //
        // 返回结果:
        //     在此请求中使用的协议方法。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     在子类中未重写该属性的情况下，尝试获取或设置该属性。
        public virtual string Method { get; set; }
        //
        // 摘要:
        //     获取或设置用于此请求的身份验证和模拟的级别。
        //
        // 返回结果:
        //     System.Net.Security.AuthenticationLevel 值的按位组合。默认值为 System.Net.Security.AuthenticationLevel.MutualAuthRequested。在相互身份验证中，客户端和服务器双方都出示凭据以确定其身份。System.Net.Security.AuthenticationLevel.MutualAuthRequired
        //     和 System.Net.Security.AuthenticationLevel.MutualAuthRequested 值与 Kerberos 身份验证有关。可以直接支持
        //     Kerberos 身份验证，也可以仅在使用 Negotiate 安全协议选择实际的安全协议时使用该身份验证。有关身份验证协议的更多信息，请参见 Internet
        //     身份验证。若要确定相互身份验证是否发生，请检查 System.Net.WebResponse.IsMutuallyAuthenticated 属性。如果您指定了
        //     System.Net.Security.AuthenticationLevel.MutualAuthRequired 身份验证标志值，而未发生相互身份验证，则应用程序将收到一个带有
        //     System.Net.ProtocolViolationException 内部异常的 System.IO.IOException，指示相互身份验证失败。
        public AuthenticationLevel AuthenticationLevel { get; set; }
        //
        // 摘要:
        //     获取或设置请求超时之前的时间长度（以毫秒为单位）。
        //
        // 返回结果:
        //     请求超时前的时间长度（以毫秒为单位）或指示请求不超时的 System.Threading.Timeout.Infinite 值。默认值是由子代类定义的。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该属性时，尝试获取或设置该属性。
        public virtual int Timeout { get; set; }
        //
        // 摘要:
        //     当在子类中被重写时，指示是否对请求进行预身份验证。
        //
        // 返回结果:
        //     若要进行预身份验证，则为 true；否则为 false。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该属性时，尝试获取或设置该属性。
        public virtual bool PreAuthenticate { get; set; }
        //
        // 摘要:
        //     当在子类中被重写时，获取或设置用于访问此 Internet 资源的网络代理。
        //
        // 返回结果:
        //     用于访问 Internet 资源的 System.Net.IWebProxy。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该属性时，尝试获取或设置该属性。
        public virtual IWebProxy Proxy { get; set; }
        //
        // 摘要:
        //     当在子代类中重写时，获取或设置一个 System.Boolean 值，该值控制 System.Net.CredentialCache.DefaultCredentials
        //     是否随请求一起发送。
        //
        // 返回结果:
        //     如果使用默认凭据，则为 true；否则为 false。默认值为 false。
        //
        // 异常:
        //   T:System.InvalidOperationException:
        //     您尝试在该请求发送之后设置此属性。
        public virtual bool UseDefaultCredentials { get; set; }
        //
        // 摘要:
        //     当在子类中被重写时，获取或设置用于对 Internet 资源请求进行身份验证的网络凭据。
        //
        // 返回结果:
        //     包含与该请求关联的身份验证凭据的 System.Net.ICredentials。默认值为 null。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该属性时，尝试获取或设置该属性。
        public virtual ICredentials Credentials { get; set; }
        //
        // 摘要:
        //     当在子类中被重写时，获取或设置所发送的请求数据的内容类型。
        //
        // 返回结果:
        //     请求数据的内容类型。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该属性时，尝试获取或设置该属性。
        public virtual string ContentType { get; set; }
        //
        // 摘要:
        //     当在子类中被重写时，获取或设置所发送的请求数据的内容长度。
        //
        // 返回结果:
        //     发送的请求数据的字节数。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该属性时，尝试获取或设置该属性。
        public virtual long ContentLength { get; set; }
        //
        // 摘要:
        //     当在子类中被重写时，获取或设置与请求关联的标头名称/值对的集合。
        //
        // 返回结果:
        //     包含与此请求关联的标题名/值对的 System.Net.WebHeaderCollection。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该属性时，尝试获取或设置该属性。
        public virtual WebHeaderCollection Headers { get; set; }
        //
        // 摘要:
        //     当在子类中重写时，获取或设置请求的连接组的名称。
        //
        // 返回结果:
        //     请求的连接组的名称。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该属性时，尝试获取或设置该属性。
        public virtual string ConnectionGroupName { get; set; }
        //
        // 摘要:
        //     获取或设置当前请求的模拟级别。
        //
        // 返回结果:
        //     System.Security.Principal.TokenImpersonationLevel 值。
        public TokenImpersonationLevel ImpersonationLevel { get; set; }
        //
        // 摘要:
        //     获取或设置此请求的缓存策略。
        //
        // 返回结果:
        //     定义缓存策略的 System.Net.Cache.RequestCachePolicy 对象。
        public virtual RequestCachePolicy CachePolicy { get; set; }
        //
        // 摘要:
        //     当在子类中被重写时，获取与请求关联的 Internet 资源的 URI。
        //
        // 返回结果:
        //     表示与请求关联的资源的 System.Uri。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该属性时，尝试获取或设置该属性。
        public virtual Uri RequestUri { get; }

        //
        // 摘要:
        //     为指定的 URI 方案初始化新的 System.Net.WebRequest 实例。
        //
        // 参数:
        //   requestUriString:
        //     标识 Internet 资源的 URI。
        //
        // 返回结果:
        //     特定 URI 方案的 System.Net.WebRequest 子代。
        //
        // 异常:
        //   T:System.NotSupportedException:
        //     requestUriString 中指定的请求方案尚未注册。
        //
        //   T:System.ArgumentNullException:
        //     requestUriString 为 null。
        //
        //   T:System.Security.SecurityException:
        //     调用方没有连接到请求的 URI 或请求重定向到的 URI 上的权限。
        //
        //   T:System.UriFormatException:
        //     requestUriString 中指定的 URI 不是有效的 URI。
        public static WebRequest Create( string requestUriString );
        //
        // 摘要:
        //     为指定的 URI 方案初始化新的 System.Net.WebRequest 实例。
        //
        // 参数:
        //   requestUri:
        //     包含请求的资源的 URI 的 System.Uri。
        //
        // 返回结果:
        //     指定的 URI 方案的 System.Net.WebRequest 子代。
        //
        // 异常:
        //   T:System.NotSupportedException:
        //     requestUri 中指定的请求方案未注册。
        //
        //   T:System.ArgumentNullException:
        //     requestUri 为 null。
        //
        //   T:System.Security.SecurityException:
        //     调用方没有连接到请求的 URI 或请求重定向到的 URI 上的权限。
        public static WebRequest Create( Uri requestUri );
        //
        // 摘要:
        //     为指定的 URI 方案初始化新的 System.Net.WebRequest 实例。
        //
        // 参数:
        //   requestUri:
        //     包含请求的资源的 URI 的 System.Uri。
        //
        // 返回结果:
        //     指定的 URI 方案的 System.Net.WebRequest 子代。
        //
        // 异常:
        //   T:System.NotSupportedException:
        //     requestUri 中指定的请求方案未注册。
        //
        //   T:System.ArgumentNullException:
        //     requestUri 为 null。
        //
        //   T:System.Security.SecurityException:
        //     调用方没有连接到请求的 URI 或请求重定向到的 URI 上的权限。
        public static WebRequest CreateDefault( Uri requestUri );
        //
        // 摘要:
        //     返回当前模拟用户的 Internet Explorer 设置中配置的代理。
        //
        // 返回结果:
        //     对 System.Net.WebRequest 实例的每一次调用所使用的 System.Net.IWebProxy。
        public static IWebProxy GetSystemWebProxy();
        //
        // 摘要:
        //     为指定的 URI 注册 System.Net.WebRequest 子代。
        //
        // 参数:
        //   prefix:
        //     System.Net.WebRequest 子代为其提供服务的完整 URI 或 URI 前缀。
        //
        //   creator:
        //     创建方法，System.Net.WebRequest 调用它以创建 System.Net.WebRequest 子代。
        //
        // 返回结果:
        //     如果注册成功，则为 true；否则为 false。
        //
        // 异常:
        //   T:System.ArgumentNullException:
        //     prefix 为 null。- 或 -creator 为 null。
        public static bool RegisterPrefix( string prefix, IWebRequestCreate creator );
        //
        // 摘要:
        //     中止请求
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该方法时，尝试访问该方法。
        public virtual void Abort();
        //
        // 摘要:
        //     当在子类中重写时，提供 System.Net.WebRequest.GetRequestStream 方法的异步版本。
        //
        // 参数:
        //   callback:
        //     System.AsyncCallback 委托。
        //
        //   state:
        //     包含此异步请求的状态信息的对象。
        //
        // 返回结果:
        //     引用该异步请求的 System.IAsyncResult。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该方法时，尝试访问该方法。
        public virtual IAsyncResult BeginGetRequestStream( AsyncCallback callback, object state );
        //
        // 摘要:
        //     当在子类中被重写时，开始对 Internet 资源的异步请求。
        //
        // 参数:
        //   callback:
        //     System.AsyncCallback 委托。
        //
        //   state:
        //     包含此异步请求的状态信息的对象。
        //
        // 返回结果:
        //     引用该异步请求的 System.IAsyncResult。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该方法时，尝试访问该方法。
        public virtual IAsyncResult BeginGetResponse( AsyncCallback callback, object state );
        //
        // 摘要:
        //     当在子类中重写时，返回用于将数据写入 Internet 资源的 System.IO.Stream。
        //
        // 参数:
        //   asyncResult:
        //     引用对流的挂起请求的 System.IAsyncResult。
        //
        // 返回结果:
        //     将数据写入的 System.IO.Stream。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该方法时，尝试访问该方法。
        public virtual Stream EndGetRequestStream( IAsyncResult asyncResult );
        //
        // 摘要:
        //     当在子类中重写时，返回 System.Net.WebResponse。
        //
        // 参数:
        //   asyncResult:
        //     引用对响应的挂起请求的 System.IAsyncResult。
        //
        // 返回结果:
        //     包含对 Internet 请求的响应的 System.Net.WebResponse。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该方法时，尝试访问该方法。
        public virtual WebResponse EndGetResponse( IAsyncResult asyncResult );
        //
        // 摘要:
        //     当在子类中重写时，返回用于将数据写入 Internet 资源的 System.IO.Stream。
        //
        // 返回结果:
        //     用于将数据写入 Internet 资源的 System.IO.Stream。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该方法时，尝试访问该方法。
        public virtual Stream GetRequestStream();
        //
        // 摘要:
        //     当在子类中被重写时，返回对 Internet 请求的响应。
        //
        // 返回结果:
        //     包含对 Internet 请求的响应的 System.Net.WebResponse。
        //
        // 异常:
        //   T:System.NotImplementedException:
        //     当未在子类中重写该方法时，尝试访问该方法。
        public virtual WebResponse GetResponse();
        //
        // 摘要:
        //     使用将目标对象序列化所需的数据填充 System.Runtime.Serialization.SerializationInfo。
        //
        // 参数:
        //   serializationInfo:
        //     要填充数据的 System.Runtime.Serialization.SerializationInfo。
        //
        //   streamingContext:
        //     用于指定该序列化的目标的 System.Runtime.Serialization.StreamingContext。
        protected virtual void GetObjectData( SerializationInfo serializationInfo, StreamingContext streamingContext );
    }
}