HttpClientHandler クラス

定義

名前空間:

System.Net.Http

アセンブリ:

netstandard.dll, System.Net.Http.dll

ソース:

HttpClientHandler.cs

.NET Framework で HttpClient によって使用される既定のメッセージ ハンドラー。

public ref class HttpClientHandler : System::Net::Http::HttpMessageHandler

public class HttpClientHandler : System.Net.Http.HttpMessageHandler

type HttpClientHandler = class
    inherit HttpMessageHandler

Public Class HttpClientHandler
Inherits HttpMessageHandler

継承

Object

HttpMessageHandler

HttpClientHandler

派生

System.Net.Http.WebRequestHandler

例

static async Task Main()
{
   // Create an HttpClientHandler object and set to use default credentials
   HttpClientHandler handler = new HttpClientHandler();
   handler.UseDefaultCredentials = true;

   // Create an HttpClient object
   HttpClient client = new HttpClient(handler);

   // Call asynchronous network methods in a try/catch block to handle exceptions
   try
   {
      HttpResponseMessage response = await client.GetAsync("http://www.contoso.com/");

      response.EnsureSuccessStatusCode();

      string responseBody = await response.Content.ReadAsStringAsync();
      Console.WriteLine(responseBody);
   }
   catch(HttpRequestException e)
   {
       Console.WriteLine("\nException Caught!");
       Console.WriteLine("Message :{0} ",e.Message);
   }

   // Need to call dispose on the HttpClient and HttpClientHandler objects
   // when done using them, so the app doesn't leak resources
   handler.Dispose();
   client.Dispose();
}

注釈

この API の詳細については、「 HttpClientHandler の補足 API 解説」を参照してください。

コンストラクター

名前	説明
HttpClientHandler()	HttpClientHandler クラスのインスタンスを作成します。

プロパティ

名前	説明
AllowAutoRedirect	ハンドラーがリダイレクト応答に従う必要があるかどうかを示す値を取得または設定します。
AutomaticDecompression	HTTP コンテンツ応答の自動展開にハンドラーによって使用される展開メソッドの種類を取得または設定します。
CheckCertificateRevocationList	証明書が証明機関失効リストに対してチェックされるかどうかを示す値を取得または設定します。
ClientCertificateOptions	証明書が証明書ストアから自動的に選択されるかどうか、または呼び出し元が特定のクライアント証明書を渡すことが許可されているかどうかを示す値を取得または設定します。
ClientCertificates	サーバーへの要求に関連付けられているセキュリティ証明書のコレクションを取得します。
CookieContainer	ハンドラーによってサーバー Cookie を格納するために使用される Cookie コンテナーを取得または設定します。
Credentials	このハンドラーで使用される認証情報を取得または設定します。
DangerousAcceptAnyServerCertificateValidator	常に trueを返すキャッシュされたデリゲートを取得します。
DefaultProxyCredentials	既定の (システム) プロキシが使用されている場合は、認証のために既定のプロキシ サーバーに送信する資格情報を取得または設定します。 既定のプロキシは、 UseProxy が true に設定され、 Proxy が null に設定されている場合にのみ使用されます。
MaxAutomaticRedirections	ハンドラーがフォローするリダイレクトの最大数を取得または設定します。
MaxConnectionsPerServer	HttpClient オブジェクトを使用して要求を行うときに許可される同時接続の最大数 (サーバー エンドポイントあたり) を取得または設定します。 制限はサーバー エンドポイントごとに行われるので、たとえば値 256 を指定すると、 http://www.adatum.com/ への同時接続数は 256、 http://www.adventure-works.com/には別の 256 が許可されます。
MaxRequestContentBufferSize	ハンドラーによって使用される要求コンテンツ バッファーの最大サイズを取得または設定します。
MaxResponseHeadersLength	応答ヘッダーの最大長を KB (1024 バイト) 単位で取得または設定します。 たとえば、値が 64 の場合、応答ヘッダーの最大長に対して 65536 バイトが許可されます。
MeterFactory	HttpClientHandler インスタンスのカスタム Meterを作成するIMeterFactoryを取得または設定します。
PreAuthenticate	ハンドラーが要求と共に Authorization ヘッダーを送信するかどうかを示す値を取得または設定します。
Properties	HttpClient要求のカスタム プロパティの書き込み可能なディクショナリ (つまり、マップ) を取得します。 ディクショナリは空で初期化されます。カスタム ハンドラーと特別な処理のキーと値のペアを挿入およびクエリできます。
Proxy	ハンドラーによって使用されるプロキシ情報を取得または設定します。
ServerCertificateCustomValidationCallback	サーバー証明書を検証するコールバック メソッドを取得または設定します。
SslProtocols	HttpClientHandler オブジェクトによって管理される HttpClient オブジェクトによって使用される TLS/SSL プロトコルを取得または設定します。
SupportsAutomaticDecompression	ハンドラーが自動応答コンテンツ展開をサポートしているかどうかを示す値を取得します。
SupportsProxy	ハンドラーがプロキシ設定をサポートしているかどうかを示す値を取得します。
SupportsRedirectConfiguration	ハンドラーが AllowAutoRedirect プロパティと MaxAutomaticRedirections プロパティの構成設定をサポートするかどうかを示す値を取得します。
UseCookies	ハンドラーが CookieContainer プロパティを使用してサーバー Cookie を格納し、要求の送信時にこれらの Cookie を使用するかどうかを示す値を取得または設定します。
UseDefaultCredentials	既定の資格情報がハンドラーによって要求と共に送信されるかどうかを制御する値を取得または設定します。
UseProxy	ハンドラーが要求にプロキシを使用するかどうかを示す値を取得または設定します。

メソッド

名前	説明
Dispose()	アンマネージ リソースを解放し、 HttpMessageHandlerによって使用されるマネージド リソースを破棄します。 (継承元 HttpMessageHandler)
Dispose(Boolean)	HttpClientHandlerによって使用されるアンマネージ リソースを解放し、必要に応じてマネージド リソースを破棄します。
Equals(Object)	指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Objectの簡易コピーを作成します。 (継承元 Object)
Send(HttpRequestMessage, CancellationToken)	HttpRequestMessageで提供される情報に基づいて、HttpResponseMessageのインスタンスを作成します。
SendAsync(HttpRequestMessage, CancellationToken)	ブロックしない操作としてHttpRequestMessageで指定された情報に基づいて、HttpResponseMessageのインスタンスを作成します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

こちらもご覧ください

• Web サービスへの接続
• クイック スタート: HttpClient を使用した接続
• HttpClient ハンドラーを使用する方法
• HttpClient 接続をセキュリティで保護する方法