| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Interface IReplicationHandler |
| | Apache Lucene.NET 4.8.0-beta00009 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Interface IReplicationHandler |
| | Apache Lucene.NET 4.8.0-beta00009 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.IReplicationHandler"> |
| |
| |
| <h1 id="Lucene_Net_Replicator_IReplicationHandler" data-uid="Lucene.Net.Replicator.IReplicationHandler" class="text-break">Interface IReplicationHandler |
| </h1> |
| <div class="markdown level0 summary"><p>Handler for revisions obtained by the client.</p> |
| </div> |
| <div class="markdown level0 conceptual"></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_IReplicationHandler_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public interface IReplicationHandler</code></pre> |
| </div> |
| <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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_IReplicationHandler_CurrentRevisionFiles.md&value=---%0Auid%3A%20Lucene.Net.Replicator.IReplicationHandler.CurrentRevisionFiles%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Replicator/ReplicationClient.cs/#L491">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_IReplicationHandler_CurrentRevisionFiles_" data-uid="Lucene.Net.Replicator.IReplicationHandler.CurrentRevisionFiles*"></a> |
| <h4 id="Lucene_Net_Replicator_IReplicationHandler_CurrentRevisionFiles" data-uid="Lucene.Net.Replicator.IReplicationHandler.CurrentRevisionFiles">CurrentRevisionFiles</h4> |
| <div class="markdown level1 summary"><p>Returns the current revision version held by the handler.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">IDictionary<string, IList<RevisionFile>> CurrentRevisionFiles { 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.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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_IReplicationHandler_CurrentVersion.md&value=---%0Auid%3A%20Lucene.Net.Replicator.IReplicationHandler.CurrentVersion%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Replicator/ReplicationClient.cs/#L488">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_IReplicationHandler_CurrentVersion_" data-uid="Lucene.Net.Replicator.IReplicationHandler.CurrentVersion*"></a> |
| <h4 id="Lucene_Net_Replicator_IReplicationHandler_CurrentVersion" data-uid="Lucene.Net.Replicator.IReplicationHandler.CurrentVersion">CurrentVersion</h4> |
| <div class="markdown level1 summary"><p>Returns the current revision files held by the handler.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string CurrentVersion { 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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_IReplicationHandler_RevisionReady_System_String_System_Collections_Generic_IDictionary_System_String_System_Collections_Generic_IList_Lucene_Net_Replicator_RevisionFile___System_Collections_Generic_IDictionary_System_String_System_Collections_Generic_IList_System_String___System_Collections_Generic_IDictionary_System_String_Lucene_Net_Store_Directory__.md&value=---%0Auid%3A%20Lucene.Net.Replicator.IReplicationHandler.RevisionReady(System.String%2CSystem.Collections.Generic.IDictionary%7BSystem.String%2CSystem.Collections.Generic.IList%7BLucene.Net.Replicator.RevisionFile%7D%7D%2CSystem.Collections.Generic.IDictionary%7BSystem.String%2CSystem.Collections.Generic.IList%7BSystem.String%7D%7D%2CSystem.Collections.Generic.IDictionary%7BSystem.String%2CLucene.Net.Store.Directory%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/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Replicator/ReplicationClient.cs/#L501">View Source</a> |
| </span> |
| <a id="Lucene_Net_Replicator_IReplicationHandler_RevisionReady_" data-uid="Lucene.Net.Replicator.IReplicationHandler.RevisionReady*"></a> |
| <h4 id="Lucene_Net_Replicator_IReplicationHandler_RevisionReady_System_String_System_Collections_Generic_IDictionary_System_String_System_Collections_Generic_IList_Lucene_Net_Replicator_RevisionFile___System_Collections_Generic_IDictionary_System_String_System_Collections_Generic_IList_System_String___System_Collections_Generic_IDictionary_System_String_Lucene_Net_Store_Directory__" data-uid="Lucene.Net.Replicator.IReplicationHandler.RevisionReady(System.String,System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IList{Lucene.Net.Replicator.RevisionFile}},System.Collections.Generic.IDictionary{System.String,System.Collections.Generic.IList{System.String}},System.Collections.Generic.IDictionary{System.String,Lucene.Net.Store.Directory})">RevisionReady(String, IDictionary<String, IList<RevisionFile>>, IDictionary<String, IList<String>>, IDictionary<String, Directory>)</h4> |
| <div class="markdown level1 summary"><p>Called when a new revision was obtained and is available (i.e. all needed files were successfully copied).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">void RevisionReady(string version, IDictionary<string, IList<RevisionFile>> revisionFiles, IDictionary<string, IList<string>> copiedFiles, IDictionary<string, Directory> sourceDirectory)</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">version</span></td> |
| <td><p>The version of the <a class="xref" href="Lucene.Net.Replicator.IRevision.html">IRevision</a> that was copied</p> |
| </td> |
| </tr> |
| <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">revisionFiles</span></td> |
| <td><p>The files contained by this <a class="xref" href="Lucene.Net.Replicator.IRevision.html">IRevision</a></p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.Collections.Generic.IList</span><<span class="xref">System.String</span>>></td> |
| <td><span class="parametername">copiedFiles</span></td> |
| <td><p>The files that were actually copied</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <span class="xref">Lucene.Net.Store.Directory</span>></td> |
| <td><span class="parametername">sourceDirectory</span></td> |
| <td><p>A mapping from a source of files to the <span class="xref">Lucene.Net.Store.Directory</span> they were copied into</p> |
| </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> |
| </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-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Replicator_IReplicationHandler.md&value=---%0Auid%3A%20Lucene.Net.Replicator.IReplicationHandler%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/docs-poc/src/Lucene.Net.Replicator/ReplicationClient.cs/#L485" 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> |