| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class ReplicationClient |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class ReplicationClient |
| | 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.ReplicationClient"> |
| |
| |
| <h1 id="Lucene_Net_Replicator_ReplicationClient" data-uid="Lucene.Net.Replicator.ReplicationClient" class="text-break">Class ReplicationClient |
| </h1> |
| <div class="markdown level0 summary"><p>A client which monitors and obtains new revisions from a <a class="xref" href="Lucene.Net.Replicator.IReplicator.html">IReplicator</a>. |
| It can be used to either periodically check for updates by invoking |
| <a class="xref" href="Lucene.Net.Replicator.ReplicationClient.html#Lucene_Net_Replicator_ReplicationClient_StartUpdateThread_System_Int64_System_String_">StartUpdateThread(Int64, String)</a>, or manually by calling <a class="xref" href="Lucene.Net.Replicator.ReplicationClient.html#Lucene_Net_Replicator_ReplicationClient_UpdateNow">UpdateNow()</a>. |
| <p> |
| Whenever a new revision is available, the <a class="xref" href="Lucene.Net.Replicator.ReplicationClient.html#Lucene_Net_Replicator_ReplicationClient_RequiredFiles_System_Collections_Generic_IDictionary_System_String_System_Collections_Generic_IList_Lucene_Net_Replicator_RevisionFile___">RequiredFiles(IDictionary<String, IList<RevisionFile>>)</a> are |
| copied to the <span class="xref">Lucene.Net.Store.Directory</span> specified by <a class="xref" href="Lucene.Net.Replicator.PerSessionDirectoryFactory.html">PerSessionDirectoryFactory</a> and |
| a handler is notified.</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">ReplicationClient</span></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> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Replicator.html">Lucene.Net.Replicator</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Replicator.dll</h6> |
| <h5 id="Lucene_Net_Replicator_ReplicationClient_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class ReplicationClient : IDisposable</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Replicator_ReplicationClient_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_ReplicationClient__ctor_Lucene_Net_Replicator_IReplicator_Lucene_Net_Replicator_IReplicationHandler_Lucene_Net_Replicator_ISourceDirectoryFactory_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.%23ctor(Lucene.Net.Replicator.IReplicator%2CLucene.Net.Replicator.IReplicationHandler%2CLucene.Net.Replicator.ISourceDirectoryFactory)%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/ReplicationClient.cs/#L200">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient__ctor_" data-uid="Lucene.Net.Replicator.ReplicationClient.#ctor*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient__ctor_Lucene_Net_Replicator_IReplicator_Lucene_Net_Replicator_IReplicationHandler_Lucene_Net_Replicator_ISourceDirectoryFactory_" data-uid="Lucene.Net.Replicator.ReplicationClient.#ctor(Lucene.Net.Replicator.IReplicator,Lucene.Net.Replicator.IReplicationHandler,Lucene.Net.Replicator.ISourceDirectoryFactory)">ReplicationClient(IReplicator, IReplicationHandler, ISourceDirectoryFactory)</h4> |
| <div class="markdown level1 summary"><p>Constructor.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public ReplicationClient(IReplicator replicator, IReplicationHandler handler, ISourceDirectoryFactory factory)</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.IReplicator.html">IReplicator</a></td> |
| <td><span class="parametername">replicator</span></td> |
| <td><p>The <a class="xref" href="Lucene.Net.Replicator.IReplicator.html">IReplicator</a> used for checking for updates</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Replicator.IReplicationHandler.html">IReplicationHandler</a></td> |
| <td><span class="parametername">handler</span></td> |
| <td><p>The <a class="xref" href="Lucene.Net.Replicator.IReplicationHandler.html">IReplicationHandler</a> notified when new revisions are ready</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Replicator.ISourceDirectoryFactory.html">ISourceDirectoryFactory</a></td> |
| <td><span class="parametername">factory</span></td> |
| <td><p>The <a class="xref" href="Lucene.Net.Replicator.ISourceDirectoryFactory.html">ISourceDirectoryFactory</a> for returning a <span class="xref">Lucene.Net.Store.Directory</span> for a given source and session</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <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_ReplicationClient_INFO_STREAM_COMPONENT.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.INFO_STREAM_COMPONENT%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/ReplicationClient.cs/#L181">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_INFO_STREAM_COMPONENT" data-uid="Lucene.Net.Replicator.ReplicationClient.INFO_STREAM_COMPONENT">INFO_STREAM_COMPONENT</h4> |
| <div class="markdown level1 summary"><p>The component name to use with <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Util.InfoStream.html#Lucene_Net_Util_InfoStream_IsEnabled_System_String_">IsEnabled(String)</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 string INFO_STREAM_COMPONENT = "ReplicationThread"</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.String</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_ReplicationClient_InfoStream.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.InfoStream%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/ReplicationClient.cs/#L482">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient_InfoStream_" data-uid="Lucene.Net.Replicator.ReplicationClient.InfoStream*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_InfoStream" data-uid="Lucene.Net.Replicator.ReplicationClient.InfoStream">InfoStream</h4> |
| <div class="markdown level1 summary"><p>Gets or sets the <span class="xref">Lucene.Net.Util.InfoStream</span> to use for logging messages. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual InfoStream InfoStream { 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">Lucene.Net.Util.InfoStream</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_ReplicationClient_IsUpdateThreadAlive.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.IsUpdateThreadAlive%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/ReplicationClient.cs/#L442">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient_IsUpdateThreadAlive_" data-uid="Lucene.Net.Replicator.ReplicationClient.IsUpdateThreadAlive*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_IsUpdateThreadAlive" data-uid="Lucene.Net.Replicator.ReplicationClient.IsUpdateThreadAlive">IsUpdateThreadAlive</h4> |
| <div class="markdown level1 summary"><p>Returns true if the update thread is alive. The update thread is alive if |
| it has been <a class="xref" href="Lucene.Net.Replicator.ReplicationClient.html#Lucene_Net_Replicator_ReplicationClient_StartUpdateThread_System_Int64_System_String_">StartUpdateThread(Int64, String)</a> and not |
| <a class="xref" href="Lucene.Net.Replicator.ReplicationClient.html#Lucene_Net_Replicator_ReplicationClient_StopUpdateThread">StopUpdateThread()</a>, as well as didn't hit an error which |
| caused it to terminate (i.e. <a class="xref" href="Lucene.Net.Replicator.ReplicationClient.html#Lucene_Net_Replicator_ReplicationClient_HandleUpdateException_System_Exception_">HandleUpdateException(Exception)</a> |
| threw the exception further).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual bool IsUpdateThreadAlive { 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> |
| <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_ReplicationClient_Dispose.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.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/ReplicationClient.cs/#L395">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient_Dispose_" data-uid="Lucene.Net.Replicator.ReplicationClient.Dispose*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_Dispose" data-uid="Lucene.Net.Replicator.ReplicationClient.Dispose">Dispose()</h4> |
| <div class="markdown level1 summary"></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_ReplicationClient_Dispose_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.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/ReplicationClient.cs/#L386">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient_Dispose_" data-uid="Lucene.Net.Replicator.ReplicationClient.Dispose*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_Dispose_System_Boolean_" data-uid="Lucene.Net.Replicator.ReplicationClient.Dispose(System.Boolean)">Dispose(Boolean)</h4> |
| <div class="markdown level1 summary"></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_ReplicationClient_EnsureOpen.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.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/ReplicationClient.cs/#L317">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient_EnsureOpen_" data-uid="Lucene.Net.Replicator.ReplicationClient.EnsureOpen*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_EnsureOpen" data-uid="Lucene.Net.Replicator.ReplicationClient.EnsureOpen">EnsureOpen()</h4> |
| <div class="markdown level1 summary"><p>Throws <span class="xref">System.ObjectDisposedException</span> if the client has already been 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> |
| <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_ReplicationClient_HandleUpdateException_System_Exception_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.HandleUpdateException(System.Exception)%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/ReplicationClient.cs/#L344">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient_HandleUpdateException_" data-uid="Lucene.Net.Replicator.ReplicationClient.HandleUpdateException*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_HandleUpdateException_System_Exception_" data-uid="Lucene.Net.Replicator.ReplicationClient.HandleUpdateException(System.Exception)">HandleUpdateException(Exception)</h4> |
| <div class="markdown level1 summary"><p>Called when an exception is hit by the replication thread. The default |
| implementation prints the full stacktrace to the <span class="xref">Lucene.Net.Util.InfoStream</span> set in |
| <a class="xref" href="Lucene.Net.Replicator.ReplicationClient.html#Lucene_Net_Replicator_ReplicationClient_InfoStream">InfoStream</a>, or the <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Util.InfoStream.html#Lucene_Net_Util_InfoStream_Default">Default</a> |
| one. You can override to log the exception elsewhere.</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 HandleUpdateException(Exception exception)</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.Exception</span></td> |
| <td><span class="parametername">exception</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Replicator_ReplicationClient_HandleUpdateException_System_Exception__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p><strong>NOTE:</strong> If you override this method to throw the exception further, |
| the replication thread will be terminated. The only way to restart it is to |
| call <a class="xref" href="Lucene.Net.Replicator.ReplicationClient.html#Lucene_Net_Replicator_ReplicationClient_StopUpdateThread">StopUpdateThread()</a> followed by |
| <a class="xref" href="Lucene.Net.Replicator.ReplicationClient.html#Lucene_Net_Replicator_ReplicationClient_StartUpdateThread_System_Int64_System_String_">StartUpdateThread(Int64, String)</a>.</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_ReplicationClient_RequiredFiles_System_Collections_Generic_IDictionary_System_String_System_Collections_Generic_IList_Lucene_Net_Replicator_RevisionFile___.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.RequiredFiles(System.Collections.Generic.IDictionary%7BSystem.String%2CSystem.Collections.Generic.IList%7BLucene.Net.Replicator.RevisionFile%7D%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/ReplicationClient.cs/#L353">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient_RequiredFiles_" data-uid="Lucene.Net.Replicator.ReplicationClient.RequiredFiles*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_RequiredFiles_System_Collections_Generic_IDictionary_System_String_System_Collections_Generic_IList_Lucene_Net_Replicator_RevisionFile___" data-uid="Lucene.Net.Replicator.ReplicationClient.RequiredFiles(System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IList{Lucene.Net.Replicator.RevisionFile}})">RequiredFiles(IDictionary<String, IList<RevisionFile>>)</h4> |
| <div class="markdown level1 summary"><p>Returns the files required for replication. By default, this method returns |
| all files that exist in the new revision, but not in the handler.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual IDictionary<string, IList<RevisionFile>> RequiredFiles(IDictionary<string, IList<RevisionFile>> newRevisionFiles)</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.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Replicator.RevisionFile.html">RevisionFile</a>>></td> |
| <td><span class="parametername">newRevisionFiles</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.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.Collections.Generic.IList</span><<a class="xref" href="Lucene.Net.Replicator.RevisionFile.html">RevisionFile</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_ReplicationClient_StartUpdateThread_System_Int64_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.StartUpdateThread(System.Int64%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_beta00010/src/Lucene.Net.Replicator/ReplicationClient.cs/#L408">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient_StartUpdateThread_" data-uid="Lucene.Net.Replicator.ReplicationClient.StartUpdateThread*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_StartUpdateThread_System_Int64_System_String_" data-uid="Lucene.Net.Replicator.ReplicationClient.StartUpdateThread(System.Int64,System.String)">StartUpdateThread(Int64, String)</h4> |
| <div class="markdown level1 summary"><p>Start the update thread with the specified interval in milliseconds. For |
| debugging purposes, you can optionally set the name to set on |
| <span class="xref">Lucene.Net.Replicator.ReplicationClient.ReplicationThread.Name</span>. If you pass <code>null</code>, a default name |
| will be set.</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 StartUpdateThread(long intervalMillis, string threadName)</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.Int64</span></td> |
| <td><span class="parametername">intervalMillis</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">threadName</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.InvalidOperationException</span></td> |
| <td><p>if the thread has already been started </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_ReplicationClient_StopUpdateThread.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.StopUpdateThread%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/ReplicationClient.cs/#L425">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient_StopUpdateThread_" data-uid="Lucene.Net.Replicator.ReplicationClient.StopUpdateThread*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_StopUpdateThread" data-uid="Lucene.Net.Replicator.ReplicationClient.StopUpdateThread">StopUpdateThread()</h4> |
| <div class="markdown level1 summary"><p>Stop the update thread. If the update thread is not running, silently does |
| nothing. This method returns after the update thread has stopped.</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 StopUpdateThread()</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_ReplicationClient_ToString.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.ToString%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/ReplicationClient.cs/#L444">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient_ToString_" data-uid="Lucene.Net.Replicator.ReplicationClient.ToString*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_ToString" data-uid="Lucene.Net.Replicator.ReplicationClient.ToString">ToString()</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override string ToString()</code></pre> |
| </div> |
| <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.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><span class="xref">System.Object.ToString()</span></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_ReplicationClient_UpdateNow.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient.UpdateNow%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/ReplicationClient.cs/#L456">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_ReplicationClient_UpdateNow_" data-uid="Lucene.Net.Replicator.ReplicationClient.UpdateNow*"></a> |
| <h4 id="Lucene_Net_Replicator_ReplicationClient_UpdateNow" data-uid="Lucene.Net.Replicator.ReplicationClient.UpdateNow">UpdateNow()</h4> |
| <div class="markdown level1 summary"><p>Executes the update operation immediately, regardless if an update thread |
| is running or not.</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 UpdateNow()</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.IO.IOException</span></td> |
| <td></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_ReplicationClient.md&value=---%0Auid%3A%20Lucene.Net.Replicator.ReplicationClient%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/ReplicationClient.cs/#L44" 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> |
