blob: 665de612c17032e9495cf19b946baecd7d61c5cd [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>stress-test | Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="stress-test | Apache Lucene.NET 4.8.0-beta00010 Documentation ">
<meta name="generator" content="docfx 2.56.0.0">
<link rel="shortcut icon" href="../../logo/favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">
<meta property="docfx:rel" content="../../">
</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="../../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" id="breadcrumb">
<ul class="breadcrumb">
<li></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="">
<h1 id="stress-test">stress-test</h1>
<h3 id="name">Name</h3>
<p><code>lock-stress-test</code> - Simple tool that forever acquires and releases a lock using a specific <code>LockFactory</code>.</p>
<h3 id="synopsis">Synopsis</h3>
<p><code>lucene lock stress-test &lt;ID&gt; &lt;VERIFIER_HOST&gt; &lt;VERIFIER_PORT&gt; &lt;LOCK_FACTORY_TYPE&gt; &lt;LOCK_DIRECTORY&gt; &lt;SLEEP_TIME_MS&gt; &lt;TRIES&gt; [?|-h|--help]</code></p>
<h3 id="description">Description</h3>
<p>You should run multiple instances of this process, each with its own unique ID, and each pointing to the same lock directory, to verify that locking is working correctly. Make sure you are first running <a href="verify-server.html">verify-server</a>.</p>
<h3 id="arguments">Arguments</h3>
<p><code>ID</code></p>
<p>An integer from 0 - 255 (should be unique for test process).</p>
<p><code>VERIFIER_HOST</code></p>
<p>Hostname or IP address that <a href="verify-server.html">verify-server</a> is listening on.</p>
<p><code>VERIFIER_PORT</code></p>
<p>Port that <a href="verify-server.html">verify-server</a> is listening on.</p>
<p><code>LOCK_FACTORY_TYPE</code></p>
<p>The primary LockFactory implementation that we will use.</p>
<p><code>LOCK_DIRECTORY</code></p>
<p>The path to the lock directory (only utilized if <code>LOCK_FACTORY_TYPE</code> is set to <code>SimpleFSLockFactory</code> or <code>NativeFSLockFactory</code>).</p>
<p><code>SLEEP_TIME_MS</code></p>
<p>Milliseconds to pause between each lock obtain/release.</p>
<p><code>TRIES</code></p>
<p>Number of locking tries.</p>
<h3 id="options">Options</h3>
<p><code>?|-h|--help</code></p>
<p>Prints out a short help for the command.</p>
<h3 id="example">Example</h3>
<p>Run the client (stress test), connecting to the server on IP address <code>127.0.0.4</code> and port <code>54464</code> using the ID 3, the <code>NativeFSLockFactory</code>, specifying the lock directory as <code>F:\temp</code>, sleep for 50 milliseconds, and try to obtain a lock up to 10 times:</p>
<p><code>lucene lock stress-test 3 127.0.0.4 54464 NativeFSLockFactory F:\temp 50 10</code></p>
</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/blob/docs/4.8.0-beta00010/src/dotnet/tools/lucene-cli/docs/lock/stress-test.md/#L1" class="contribution-link">Improve this Doc</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="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>