| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class HttpClientBase |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class HttpClientBase |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="replicator/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Replicator.Http.HttpClientBase"> |
| |
| |
| <h1 id="Lucene_Net_Replicator_Http_HttpClientBase" data-uid="Lucene.Net.Replicator.Http.HttpClientBase" class="text-break">Class HttpClientBase |
| </h1> |
| <div class="markdown level0 summary"><p>Base class for Http clients.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">HttpClientBase</span></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Replicator.Http.HttpReplicator.html">HttpReplicator</a></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">System.IDisposable</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Replicator.Http.html">Lucene.Net.Replicator.Http</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Replicator.dll</h6> |
| <h5 id="Lucene_Net_Replicator_Http_HttpClientBase_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class HttpClientBase : IDisposable</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Replicator_Http_HttpClientBase_remarks"><strong>Remarks</strong></h5> |
| <div class="markdown level0 remarks"><div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Int32_System_String_System_Net_Http_HttpMessageHandler_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.%23ctor(System.String%2CSystem.Int32%2CSystem.String%2CSystem.Net.Http.HttpMessageHandler)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L68">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase__ctor_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.#ctor*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Int32_System_String_System_Net_Http_HttpMessageHandler_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.#ctor(System.String,System.Int32,System.String,System.Net.Http.HttpMessageHandler)">HttpClientBase(String, Int32, String, HttpMessageHandler)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html">HttpClientBase</a> with the given host, port and path.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected HttpClientBase(string host, int port, string path, HttpMessageHandler messageHandler = null)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">host</span></td> |
| <td><p>The host that the client should retrieve data from.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">port</span></td> |
| <td><p>The port to be used to connect on.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">path</span></td> |
| <td><p>The path to the replicator on the host.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpMessageHandler</span></td> |
| <td><span class="parametername">messageHandler</span></td> |
| <td><p>Optional, The HTTP handler stack to use for sending requests, defaults to <code>null</code>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Int32_System_String_System_Net_Http_HttpMessageHandler__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>The host, port and path parameters are normalized to <code>http://{host}:{port}{path}</code>, |
| if path is <code>null</code> or <code>empty</code> it defaults to <code>/</code>. |
| <p> |
| A <span class="xref">System.Net.Http.HttpMessageHandler</span> is taken as an optional parameter as well, if this is not provided it defaults to <code>null</code>. |
| In this case the internal <span class="xref">System.Net.Http.HttpClient</span> will default to use a <span class="xref">System.Net.Http.HttpClientHandler</span>.</p> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Net_Http_HttpClient_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.%23ctor(System.String%2CSystem.Net.Http.HttpClient)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L98">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase__ctor_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.#ctor*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Net_Http_HttpClient_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.#ctor(System.String,System.Net.Http.HttpClient)">HttpClientBase(String, HttpClient)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html">HttpClientBase</a> with the given <code data-dev-comment-type="paramref" class="paramref">url</code> and <span class="xref">System.Net.Http.HttpClient</span>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected HttpClientBase(string url, HttpClient client)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">url</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpClient</span></td> |
| <td><span class="parametername">client</span></td> |
| <td><p>The <span class="xref">System.Net.Http.HttpClient</span> to use make remote http calls.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Net_Http_HttpClient__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>This allows full controll over how the <span class="xref">System.Net.Http.HttpClient</span> is created, |
| prefer the <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Net_Http_HttpMessageHandler_">HttpClientBase(String, HttpMessageHandler)</a> over this unless you know you need the control of the <span class="xref">System.Net.Http.HttpClient</span>.</p> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Net_Http_HttpMessageHandler_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.%23ctor(System.String%2CSystem.Net.Http.HttpMessageHandler)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L83">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase__ctor_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.#ctor*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Net_Http_HttpMessageHandler_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.#ctor(System.String,System.Net.Http.HttpMessageHandler)">HttpClientBase(String, HttpMessageHandler)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html">HttpClientBase</a> with the given <code data-dev-comment-type="paramref" class="paramref">url</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected HttpClientBase(string url, HttpMessageHandler messageHandler = null)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">url</span></td> |
| <td><p>The full url, including with host, port and path.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpMessageHandler</span></td> |
| <td><span class="parametername">messageHandler</span></td> |
| <td><p>Optional, The HTTP handler stack to use for sending requests.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Net_Http_HttpMessageHandler__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>A <span class="xref">System.Net.Http.HttpMessageHandler</span> is taken as an optional parameter as well, if this is not provided it defaults to <code>null</code>. |
| In this case the internal <span class="xref">System.Net.Http.HttpClient</span> will default to use a <span class="xref">System.Net.Http.HttpClientHandler</span>.</p> |
| </div> |
| <h3 id="fields">Fields |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_DEFAULT_CONNECTION_TIMEOUT.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.DEFAULT_CONNECTION_TIMEOUT%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L42">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_DEFAULT_CONNECTION_TIMEOUT" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.DEFAULT_CONNECTION_TIMEOUT">DEFAULT_CONNECTION_TIMEOUT</h4> |
| <div class="markdown level1 summary"><p>Default connection timeout for this client, in milliseconds. |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_ConnectionTimeout">ConnectionTimeout</a></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public const int DEFAULT_CONNECTION_TIMEOUT = 1000</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="properties">Properties |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_ConnectionTimeout.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.ConnectionTimeout%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L109">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_ConnectionTimeout_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ConnectionTimeout*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_ConnectionTimeout" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ConnectionTimeout">ConnectionTimeout</h4> |
| <div class="markdown level1 summary"><p>Gets or Sets the connection timeout for this client, in milliseconds. This setting |
| is used to modify <span class="xref">System.Net.Http.HttpClient.Timeout</span>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int ConnectionTimeout { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_IsDisposed.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.IsDisposed%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L267">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_IsDisposed_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.IsDisposed*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_IsDisposed" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.IsDisposed">IsDisposed</h4> |
| <div class="markdown level1 summary"><p>Returns <code>true</code> if this instance was <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_Dispose_System_Boolean_">Dispose(Boolean)</a>ed, otherwise |
| returns <code>false</code>. Note that if you override <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_Dispose_System_Boolean_">Dispose(Boolean)</a>, you must call |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_Dispose_System_Boolean_">Dispose(Boolean)</a> on the base class, in order for this instance to be properly disposed.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public bool IsDisposed { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_Url.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.Url%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L49">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_Url_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.Url*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_Url" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.Url">Url</h4> |
| <div class="markdown level1 summary"><p>The URL to execute requests against. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected string Url { get; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_Dispose.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.Dispose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L325">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_Dispose_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.Dispose*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_Dispose" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.Dispose">Dispose()</h4> |
| <div class="markdown level1 summary"><p>Disposes this <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html">HttpClientBase</a>. |
| This disposes the underlying <span class="xref">System.Net.Http.HttpClient</span>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void Dispose()</code></pre> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_Dispose_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.Dispose(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L312">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_Dispose_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.Dispose*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_Dispose_System_Boolean_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.Dispose(System.Boolean)">Dispose(Boolean)</h4> |
| <div class="markdown level1 summary"><p>Disposes this <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html">HttpClientBase</a>. |
| When called with <pre><code>true</code></pre>, this disposes the underlying <span class="xref">System.Net.Http.HttpClient</span>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void Dispose(bool disposing)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">disposing</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_DoAction__1_System_Net_Http_HttpResponseMessage_System_Boolean_System_Func___0__.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.DoAction%60%601(System.Net.Http.HttpResponseMessage%2CSystem.Boolean%2CSystem.Func%7B%60%600%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L282">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_DoAction_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.DoAction*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_DoAction__1_System_Net_Http_HttpResponseMessage_System_Boolean_System_Func___0__" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.DoAction``1(System.Net.Http.HttpResponseMessage,System.Boolean,System.Func{``0})">DoAction<T>(HttpResponseMessage, Boolean, Func<T>)</h4> |
| <div class="markdown level1 summary"><p>Do a specific action and validate after the action that the status is still OK, |
| and if not, attempt to extract the actual server side exception. Optionally |
| release the response at exit, depending on <code data-dev-comment-type="paramref" class="paramref">consume</code> parameter.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual T DoAction<T>(HttpResponseMessage response, bool consume, Func<T> call)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpResponseMessage</span></td> |
| <td><span class="parametername">response</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">consume</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Func</span><T></td> |
| <td><span class="parametername">call</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_DoAction__1_System_Net_Http_HttpResponseMessage_System_Func___0__.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.DoAction%60%601(System.Net.Http.HttpResponseMessage%2CSystem.Func%7B%60%600%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L272">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_DoAction_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.DoAction*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_DoAction__1_System_Net_Http_HttpResponseMessage_System_Func___0__" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.DoAction``1(System.Net.Http.HttpResponseMessage,System.Func{``0})">DoAction<T>(HttpResponseMessage, Func<T>)</h4> |
| <div class="markdown level1 summary"><p>Calls the overload <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_DoAction__1_System_Net_Http_HttpResponseMessage_System_Boolean_System_Func___0__">DoAction<T>(HttpResponseMessage, Boolean, Func<T>)</a> passing <code>true</code> to consume.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual T DoAction<T>(HttpResponseMessage response, Func<T> call)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpResponseMessage</span></td> |
| <td><span class="parametername">response</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Func</span><T></td> |
| <td><span class="parametername">call</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_EnsureOpen.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.EnsureOpen%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L119">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_EnsureOpen_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.EnsureOpen*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_EnsureOpen" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.EnsureOpen">EnsureOpen()</h4> |
| <div class="markdown level1 summary"><p>Throws <span class="xref">System.ObjectDisposedException</span> if this client is already disposed. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected void EnsureOpen()</code></pre> |
| </div> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.ObjectDisposedException</span></td> |
| <td><p>client is already disposed.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_ExecuteGet_System_String_System_String___.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.ExecuteGet(System.String%2CSystem.String%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L222">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_ExecuteGet_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ExecuteGet*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_ExecuteGet_System_String_System_String___" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ExecuteGet(System.String,System.String[])">ExecuteGet(String, String[])</h4> |
| <div class="markdown level1 summary"><p><strong>Internal:</strong> Execute a request and return its result. |
| The <code data-dev-comment-type="paramref" class="paramref">parameters</code> argument is treated as: name1,value1,name2,value2,...</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual HttpResponseMessage ExecuteGet(string request, params string[] parameters)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">request</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">parameters</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpResponseMessage</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_ExecutePost_System_String_System_Object_System_String___.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.ExecutePost(System.String%2CSystem.Object%2CSystem.String%5B%5D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L202">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_ExecutePost_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ExecutePost*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_ExecutePost_System_String_System_Object_System_String___" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ExecutePost(System.String,System.Object,System.String[])">ExecutePost(String, Object, String[])</h4> |
| <div class="markdown level1 summary"><p><strong>Internal:</strong> Execute a request and return its result. |
| The <code data-dev-comment-type="paramref" class="paramref">parameters</code> argument is treated as: name1,value1,name2,value2,...</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual HttpResponseMessage ExecutePost(string request, object entity, params string[] parameters)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">request</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Object</span></td> |
| <td><span class="parametername">entity</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">parameters</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpResponseMessage</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_ResponseInputStream_System_Net_Http_HttpResponseMessage_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.ResponseInputStream(System.Net.Http.HttpResponseMessage)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L246">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_ResponseInputStream_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ResponseInputStream*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_ResponseInputStream_System_Net_Http_HttpResponseMessage_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ResponseInputStream(System.Net.Http.HttpResponseMessage)">ResponseInputStream(HttpResponseMessage)</h4> |
| <div class="markdown level1 summary"><p>Internal utility: input stream of the provided response.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Stream ResponseInputStream(HttpResponseMessage response)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpResponseMessage</span></td> |
| <td><span class="parametername">response</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.Stream</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_ResponseInputStream_System_Net_Http_HttpResponseMessage_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.ResponseInputStream(System.Net.Http.HttpResponseMessage%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L257">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_ResponseInputStream_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ResponseInputStream*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_ResponseInputStream_System_Net_Http_HttpResponseMessage_System_Boolean_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ResponseInputStream(System.Net.Http.HttpResponseMessage,System.Boolean)">ResponseInputStream(HttpResponseMessage, Boolean)</h4> |
| <div class="markdown level1 summary"><p>Internal utility: input stream of the provided response, which optionally |
| consumes the response's resources when the input stream is exhausted.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Stream ResponseInputStream(HttpResponseMessage response, bool consume)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpResponseMessage</span></td> |
| <td><span class="parametername">response</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">consume</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.Stream</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_ThrowKnownError_System_Net_Http_HttpResponseMessage_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.ThrowKnownError(System.Net.Http.HttpResponseMessage)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L155">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_ThrowKnownError_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ThrowKnownError*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_ThrowKnownError_System_Net_Http_HttpResponseMessage_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.ThrowKnownError(System.Net.Http.HttpResponseMessage)">ThrowKnownError(HttpResponseMessage)</h4> |
| <div class="markdown level1 summary"><p>Throws an exception for any errors.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void ThrowKnownError(HttpResponseMessage response)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpResponseMessage</span></td> |
| <td><span class="parametername">response</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>IO Error happened at the server, check inner exception for details.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpRequestException</span></td> |
| <td><p>Unknown error received from the server.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase_VerifyStatus_System_Net_Http_HttpResponseMessage_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase.VerifyStatus(System.Net.Http.HttpResponseMessage)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L142">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpClientBase_VerifyStatus_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.VerifyStatus*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpClientBase_VerifyStatus_System_Net_Http_HttpResponseMessage_" data-uid="Lucene.Net.Replicator.Http.HttpClientBase.VerifyStatus(System.Net.Http.HttpResponseMessage)">VerifyStatus(HttpResponseMessage)</h4> |
| <div class="markdown level1 summary"><p><strong>Internal:</strong> Verifies the response status and if not successful throws an exception.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void VerifyStatus(HttpResponseMessage response)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpResponseMessage</span></td> |
| <td><span class="parametername">response</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>IO Error happened at the server, check inner exception for details.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpRequestException</span></td> |
| <td><p>Unknown error received from the server.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">System.IDisposable</span> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpClientBase.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpClientBase%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Replicator/Http/HttpClientBase.cs/#L36" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
