| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class HttpReplicator |
| | Apache Lucene.NET 4.8.0-beta00011 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class HttpReplicator |
| | Apache Lucene.NET 4.8.0-beta00011 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.HttpReplicator"> |
| |
| |
| <h1 id="Lucene_Net_Replicator_Http_HttpReplicator" data-uid="Lucene.Net.Replicator.Http.HttpReplicator" class="text-break">Class HttpReplicator |
| </h1> |
| <div class="markdown level0 summary"><p>An HTTP implementation of <a class="xref" href="Lucene.Net.Replicator.IReplicator.html">IReplicator</a>. Assumes the API supported by <a class="xref" href="Lucene.Net.Replicator.Http.ReplicationService.html">ReplicationService</a>.</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"><a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html">HttpClientBase</a></div> |
| <div class="level2"><span class="xref">HttpReplicator</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><a class="xref" href="Lucene.Net.Replicator.IReplicator.html">IReplicator</a></div> |
| <div><span class="xref">System.IDisposable</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_DEFAULT_CONNECTION_TIMEOUT">HttpClientBase.DEFAULT_CONNECTION_TIMEOUT</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_Url">HttpClientBase.Url</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_ConnectionTimeout">HttpClientBase.ConnectionTimeout</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_EnsureOpen">HttpClientBase.EnsureOpen()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_VerifyStatus_System_Net_Http_HttpResponseMessage_">HttpClientBase.VerifyStatus(HttpResponseMessage)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_ThrowKnownError_System_Net_Http_HttpResponseMessage_">HttpClientBase.ThrowKnownError(HttpResponseMessage)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_ExecutePost_System_String_System_Object_System_String___">HttpClientBase.ExecutePost(String, Object, String[])</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_ExecuteGet_System_String_System_String___">HttpClientBase.ExecuteGet(String, String[])</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_ResponseInputStream_System_Net_Http_HttpResponseMessage_">HttpClientBase.ResponseInputStream(HttpResponseMessage)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_ResponseInputStream_System_Net_Http_HttpResponseMessage_System_Boolean_">HttpClientBase.ResponseInputStream(HttpResponseMessage, Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_IsDisposed">HttpClientBase.IsDisposed</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_DoAction__1_System_Net_Http_HttpResponseMessage_System_Func___0__">HttpClientBase.DoAction<T>(HttpResponseMessage, Func<T>)</a> |
| </div> |
| <div> |
| <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__">HttpClientBase.DoAction<T>(HttpResponseMessage, Boolean, Func<T>)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_Dispose_System_Boolean_">HttpClientBase.Dispose(Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase_Dispose">HttpClientBase.Dispose()</a> |
| </div> |
| <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_HttpReplicator_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class HttpReplicator : HttpClientBase, IReplicator, IDisposable</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Replicator_Http_HttpReplicator_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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpReplicator__ctor_System_String_System_Int32_System_String_System_Net_Http_HttpMessageHandler_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpReplicator.%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_beta00011/src/Lucene.Net.Replicator/Http/HttpReplicator.cs/#L37">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpReplicator__ctor_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.#ctor*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpReplicator__ctor_System_String_System_Int32_System_String_System_Net_Http_HttpMessageHandler_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.#ctor(System.String,System.Int32,System.String,System.Net.Http.HttpMessageHandler)">HttpReplicator(String, Int32, String, HttpMessageHandler)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Replicator.Http.HttpReplicator.html">HttpReplicator</a> with the given host, port and path. |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Int32_System_String_System_Net_Http_HttpMessageHandler_">HttpClientBase(String, Int32, String, HttpMessageHandler)</a> for more details.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public HttpReplicator(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></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">port</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">path</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpMessageHandler</span></td> |
| <td><span class="parametername">messageHandler</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpReplicator__ctor_System_String_System_Net_Http_HttpClient_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpReplicator.%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_beta00011/src/Lucene.Net.Replicator/Http/HttpReplicator.cs/#L57">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpReplicator__ctor_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.#ctor*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpReplicator__ctor_System_String_System_Net_Http_HttpClient_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.#ctor(System.String,System.Net.Http.HttpClient)">HttpReplicator(String, HttpClient)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Replicator.Http.HttpReplicator.html">HttpReplicator</a> with the given <code data-dev-comment-type="paramref" class="paramref">url</code> and <span class="xref">System.Net.Http.HttpClient</span>. |
| <a class="xref" href="Lucene.Net.Replicator.Http.HttpClientBase.html#Lucene_Net_Replicator_Http_HttpClientBase__ctor_System_String_System_Net_Http_HttpClient_">HttpClientBase(String, HttpClient)</a> for more details.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public HttpReplicator(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></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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpReplicator__ctor_System_String_System_Net_Http_HttpMessageHandler_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpReplicator.%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_beta00011/src/Lucene.Net.Replicator/Http/HttpReplicator.cs/#L47">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpReplicator__ctor_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.#ctor*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpReplicator__ctor_System_String_System_Net_Http_HttpMessageHandler_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.#ctor(System.String,System.Net.Http.HttpMessageHandler)">HttpReplicator(String, HttpMessageHandler)</h4> |
| <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="Lucene.Net.Replicator.Http.HttpReplicator.html">HttpReplicator</a> with the given url. |
| <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> for more details.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public HttpReplicator(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></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Net.Http.HttpMessageHandler</span></td> |
| <td><span class="parametername">messageHandler</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpReplicator_CheckForUpdate_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpReplicator.CheckForUpdate(System.String)%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_beta00011/src/Lucene.Net.Replicator/Http/HttpReplicator.cs/#L65">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpReplicator_CheckForUpdate_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.CheckForUpdate*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpReplicator_CheckForUpdate_System_String_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.CheckForUpdate(System.String)">CheckForUpdate(String)</h4> |
| <div class="markdown level1 summary"><p>Checks for updates at the remote host.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual SessionToken CheckForUpdate(string currentVersion)</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">currentVersion</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><a class="xref" href="Lucene.Net.Replicator.SessionToken.html">SessionToken</a></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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpReplicator_ObtainFile_System_String_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpReplicator.ObtainFile(System.String%2CSystem.String%2CSystem.String)%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_beta00011/src/Lucene.Net.Replicator/Http/HttpReplicator.cs/#L84">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpReplicator_ObtainFile_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.ObtainFile*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpReplicator_ObtainFile_System_String_System_String_System_String_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.ObtainFile(System.String,System.String,System.String)">ObtainFile(String, String, String)</h4> |
| <div class="markdown level1 summary"><p>Obtains the given file from it's source at the remote host.</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 ObtainFile(string sessionId, string source, string fileName)</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">sessionId</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">source</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fileName</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> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpReplicator_Publish_Lucene_Net_Replicator_IRevision_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpReplicator.Publish(Lucene.Net.Replicator.IRevision)%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_beta00011/src/Lucene.Net.Replicator/Http/HttpReplicator.cs/#L97">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpReplicator_Publish_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.Publish*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpReplicator_Publish_Lucene_Net_Replicator_IRevision_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.Publish(Lucene.Net.Replicator.IRevision)">Publish(IRevision)</h4> |
| <div class="markdown level1 summary"><p>Not supported.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void Publish(IRevision revision)</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><a class="xref" href="Lucene.Net.Replicator.IRevision.html">IRevision</a></td> |
| <td><span class="parametername">revision</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.NotSupportedException</span></td> |
| <td><p>this replicator implementation does not support remote publishing of revisions</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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpReplicator_Release_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpReplicator.Release(System.String)%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_beta00011/src/Lucene.Net.Replicator/Http/HttpReplicator.cs/#L105">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_Http_HttpReplicator_Release_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.Release*"></a> |
| <h4 id="Lucene_Net_Replicator_Http_HttpReplicator_Release_System_String_" data-uid="Lucene.Net.Replicator.Http.HttpReplicator.Release(System.String)">Release(String)</h4> |
| <div class="markdown level1 summary"><p>Releases a session obtained from the remote host.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void Release(string sessionId)</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">sessionId</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Replicator.IReplicator.html">IReplicator</a> |
| </div> |
| <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-beta00011/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_Http_HttpReplicator.md&value=---%0Auid%3A%20Lucene.Net.Replicator.Http.HttpReplicator%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_beta00011/src/Lucene.Net.Replicator/Http/HttpReplicator.cs/#L31" 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> |