Kouhei Sutou
null+****@clear*****
Tue Apr 19 11:24:43 JST 2016
Kouhei Sutou 2016-04-19 11:24:43 +0900 (Tue, 19 Apr 2016) New Revision: 42af7ad160fc81b1e98dc40a18703be74b32fc14 https://github.com/groonga/groonga.org/commit/42af7ad160fc81b1e98dc40a18703be74b32fc14 Message: Add newly added documents Added files: docs/reference/command/request_timeout.html docs/sources/reference/command/request_timeout.txt ja/docs/reference/command/request_timeout.html ja/docs/sources/reference/command/request_timeout.txt Added: docs/reference/command/request_timeout.html (+232 -0) 100644 =================================================================== --- /dev/null +++ docs/reference/command/request_timeout.html 2016-04-19 11:24:43 +0900 (492a781) @@ -0,0 +1,232 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + + +<html xmlns="http://www.w3.org/1999/xhtml" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>7.3.5. Request timeout — Groonga v6.0.1 documentation</title> + + <link rel="stylesheet" href="../../static/groonga.css" type="text/css" /> + <link rel="stylesheet" href="../../static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../../', + VERSION: '6.0.1', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../static/jquery.js"></script> + <script type="text/javascript" src="../../static/underscore.js"></script> + <script type="text/javascript" src="../../static/doctools.js"></script> + <link rel="shortcut icon" href="../../static/favicon.ico"/> + <link rel="top" title="Groonga v6.0.1 documentation" href="../../index.html" /> + <link rel="up" title="7.3. Command" href="../command.html" /> + <link rel="next" title="7.3.6. Return code" href="return_code.html" /> + <link rel="prev" title="7.3.4. Request ID" href="request_id.html" /> + <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> + <meta property="fb:admins" content="664204556" /><!-- kouhei.sutou --> + <meta property="og:type" content="product" /> + <meta property="og:image" content="http://groonga.org/images/logos/groonga-icon-full-size.png" /> + <meta property="og:site_name" content="groonga" /> + + <link rel="stylesheet" href="/css/sphinx.css" type="text/css" /> + </head> + + <body role="document"> +<div class="header"> + <h1 class="title"> + <a id="top-link" href="../../../"> + <span class="project">groonga</span> + <span class="separator">-</span> + <span class="description">An open-source fulltext search engine and column store.</span> + </a> + </h1> + + <div class="facebook-buttons"> + <fb:like href="http://www.facebook.com/pages/groonga/201193596592346" + layout="standard" + width="290"></fb:like> + </div> + <div class="other-language-links"> + + <ul> + <li><a href="../../../ja/docs/reference/command/request_timeout.html">日本語</a></li> + </ul> + </div> +</div> + + + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../../genindex.html" title="General Index" + accesskey="I">index</a></li> + <li class="right" > + <a href="return_code.html" title="7.3.6. Return code" + accesskey="N">next</a> |</li> + <li class="right" > + <a href="request_id.html" title="7.3.4. Request ID" + accesskey="P">previous</a> |</li> + <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.1 documentation</a> »</li> + <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. Command</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="request-timeout"> +<h1>7.3.5. Request timeout<a class="headerlink" href="#request-timeout" title="Permalink to this headline">¶</a></h1> +<div class="section" id="summary"> +<h2>7.3.5.1. Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2> +<div class="versionadded"> +<p><span class="versionmodified">New in version 6.0.2.</span></p> +</div> +<p>You can set timeout to each request.</p> +<p>If a request isn't completed until the specified timeout, the request +is canceled. If you don't set timeout, the request is processed until +the request is completed.</p> +<p>Request timeout feature is useful when you implement timeout on client +side. If you only implement timeout only on client side, the request +keeps processing after client stops waiting response. It uses needless +resources. If you set timeout to the request, the request will be +canceled soon.</p> +</div> +<div class="section" id="how-to-set-timeout-to-request"> +<h2>7.3.5.2. How to set timeout to request<a class="headerlink" href="#how-to-set-timeout-to-request" title="Permalink to this headline">¶</a></h2> +<p>All commands accept <code class="docutils literal"><span class="pre">request_timeout</span></code> parameter. You can set timeout +to request by adding <code class="docutils literal"><span class="pre">request_timeout</span></code> parameter.</p> +<p>Unit of timeout out value is second. You can set timeout less than 1 +second by using decimal such as <code class="docutils literal"><span class="pre">0.1</span></code>. <code class="docutils literal"><span class="pre">0.1</span></code> means 100 +milliseconds.</p> +<p>Here is an example to set <code class="docutils literal"><span class="pre">5.5</span></code> seconds timeout to a request:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>select Users --request_timeout 5.5 +</pre></div> +</div> +</div> +<div class="section" id="return-code-on-timeout"> +<h2>7.3.5.3. Return code on timeout<a class="headerlink" href="#return-code-on-timeout" title="Permalink to this headline">¶</a></h2> +<p>If the request is timed out, <code class="docutils literal"><span class="pre">GRN_CANCEL</span></code> (<code class="docutils literal"><span class="pre">-77</span></code>) +<a class="reference internal" href="return_code.html"><span class="doc">Return code</span></a> is returned in response header.</p> +<p>Here is an example response on timeout:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>[ + [ + -77, + 1459846102.63304, + 0.000220775604248047, + "[request-canceler] a request is canceled: <0x7fa0d5d7ed00>" + ] +] +</pre></div> +</div> +<p>See <a class="reference internal" href="output_format.html"><span class="doc">Output format</span></a> for response header.</p> +</div> +<div class="section" id="enable-request-timeout-by-default"> +<h2>7.3.5.4. Enable request timeout by default<a class="headerlink" href="#enable-request-timeout-by-default" title="Permalink to this headline">¶</a></h2> +<p><a class="reference internal" href="../executables/groonga.html"><span class="doc">groonga executable file</span></a> supports enabling request +timeout by default. You can specify the default request timeout by +<a class="reference internal" href="../executables/groonga.html#cmdoption--default-request-timeout"><code class="xref std std-option docutils literal"><span class="pre">--default-request-timeout</span></code></a>.</p> +<p>If the default request timeout is larger than 0 second, the default +request timeout is used as request timeout for all requests.</p> +<p>You can overwrite the default request timeout by specifying +<code class="docutils literal"><span class="pre">request_timeout</span></code> parameter to request. If the default request +timeout is 3 seconds and <code class="docutils literal"><span class="pre">request_timeout</span></code> parameter is 1 second, +the request is canceled after 1 second.</p> +</div> +<div class="section" id="see-also"> +<h2>7.3.5.5. See also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2> +<ul class="simple"> +<li><a class="reference internal" href="return_code.html"><span class="doc">Return code</span></a></li> +<li><a class="reference internal" href="output_format.html"><span class="doc">Output format</span></a></li> +<li><a class="reference internal" href="../commands/request_cancel.html"><span class="doc">request_cancel</span></a></li> +</ul> +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + <h3><a href="../../index.html">Table Of Contents</a></h3> + <ul> +<li><a class="reference internal" href="#">7.3.5. Request timeout</a><ul> +<li><a class="reference internal" href="#summary">7.3.5.1. Summary</a></li> +<li><a class="reference internal" href="#how-to-set-timeout-to-request">7.3.5.2. How to set timeout to request</a></li> +<li><a class="reference internal" href="#return-code-on-timeout">7.3.5.3. Return code on timeout</a></li> +<li><a class="reference internal" href="#enable-request-timeout-by-default">7.3.5.4. Enable request timeout by default</a></li> +<li><a class="reference internal" href="#see-also">7.3.5.5. See also</a></li> +</ul> +</li> +</ul> + + <h4>Previous topic</h4> + <p class="topless"><a href="request_id.html" + title="previous chapter">7.3.4. Request ID</a></p> + <h4>Next topic</h4> + <p class="topless"><a href="return_code.html" + title="next chapter">7.3.6. Return code</a></p> + <div role="note" aria-label="source link"> + <h3>This Page</h3> + <ul class="this-page-menu"> + <li><a href="../../sources/reference/command/request_timeout.txt" + rel="nofollow">Show Source</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> + <h3>Quick search</h3> + <form class="search" action="../../search.html" method="get"> + <input type="text" name="q" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../../genindex.html" title="General Index" + >index</a></li> + <li class="right" > + <a href="return_code.html" title="7.3.6. Return code" + >next</a> |</li> + <li class="right" > + <a href="request_id.html" title="7.3.4. Request ID" + >previous</a> |</li> + <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.1 documentation</a> »</li> + <li class="nav-item nav-item-1"><a href="../../reference.html" >7. Reference manual</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" >7.3. Command</a> »</li> + </ul> + </div> + <div class="footer" role="contentinfo"> + © Copyright 2009-2016, Brazil, Inc. + </div> + <script src="http://connect.facebook.net/en_US/all.js"></script> + + <script> + FB.init({ + appId : null, + status : true, // check login status + cookie : true, // enable cookies to allow the server to access the session + xfbml : true // parse XFBML + }); + </script> + </body> + +</html> \ No newline at end of file Added: docs/sources/reference/command/request_timeout.txt (+78 -0) 100644 =================================================================== --- /dev/null +++ docs/sources/reference/command/request_timeout.txt 2016-04-19 11:24:43 +0900 (5dad5ec) @@ -0,0 +1,78 @@ +.. -*- rst -*- + +.. highlightlang:: none + +Request timeout +=============== + +Summary +------- + +.. versionadded:: 6.0.2 + +You can set timeout to each request. + +If a request isn't completed until the specified timeout, the request +is canceled. If you don't set timeout, the request is processed until +the request is completed. + +Request timeout feature is useful when you implement timeout on client +side. If you only implement timeout only on client side, the request +keeps processing after client stops waiting response. It uses needless +resources. If you set timeout to the request, the request will be +canceled soon. + +How to set timeout to request +----------------------------- + +All commands accept ``request_timeout`` parameter. You can set timeout +to request by adding ``request_timeout`` parameter. + +Unit of timeout out value is second. You can set timeout less than 1 +second by using decimal such as ``0.1``. ``0.1`` means 100 +milliseconds. + +Here is an example to set ``5.5`` seconds timeout to a request:: + + select Users --request_timeout 5.5 + +Return code on timeout +---------------------- + +If the request is timed out, ``GRN_CANCEL`` (``-77``) +:doc:`return_code` is returned in response header. + +Here is an example response on timeout:: + + [ + [ + -77, + 1459846102.63304, + 0.000220775604248047, + "[request-canceler] a request is canceled: <0x7fa0d5d7ed00>" + ] + ] + +See :doc:`/reference/command/output_format` for response header. + +Enable request timeout by default +--------------------------------- + +:doc:`/reference/executables/groonga` supports enabling request +timeout by default. You can specify the default request timeout by +:option:`--default-request-timeout`. + +If the default request timeout is larger than 0 second, the default +request timeout is used as request timeout for all requests. + +You can overwrite the default request timeout by specifying +``request_timeout`` parameter to request. If the default request +timeout is 3 seconds and ``request_timeout`` parameter is 1 second, +the request is canceled after 1 second. + +See also +-------- + +* :doc:`/reference/command/return_code` +* :doc:`/reference/command/output_format` +* :doc:`/reference/commands/request_cancel` Added: ja/docs/reference/command/request_timeout.html (+217 -0) 100644 =================================================================== --- /dev/null +++ ja/docs/reference/command/request_timeout.html 2016-04-19 11:24:43 +0900 (b004769) @@ -0,0 +1,217 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + + +<html xmlns="http://www.w3.org/1999/xhtml" lang="ja"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>7.3.5. リクエストタイムアウト — Groonga v6.0.1ドキュメント</title> + + <link rel="stylesheet" href="../../static/groonga.css" type="text/css" /> + <link rel="stylesheet" href="../../static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../../', + VERSION: '6.0.1', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../../static/jquery.js"></script> + <script type="text/javascript" src="../../static/underscore.js"></script> + <script type="text/javascript" src="../../static/doctools.js"></script> + <script type="text/javascript" src="../../static/translations.js"></script> + <link rel="shortcut icon" href="../../static/favicon.ico"/> + <link rel="top" title="Groonga v6.0.1ドキュメント" href="../../index.html" /> + <link rel="up" title="7.3. コマンド" href="../command.html" /> + <link rel="next" title="7.3.6. リターンコード" href="return_code.html" /> + <link rel="prev" title="7.3.4. リクエストID" href="request_id.html" /> + <meta property="fb:page_id" content="201193596592346" /><!-- groonga --> + <meta property="fb:admins" content="664204556" /><!-- kouhei.sutou --> + <meta property="og:type" content="product" /> + <meta property="og:image" content="http://groonga.org/images/logos/groonga-icon-full-size.png" /> + <meta property="og:site_name" content="groonga" /> + + <link rel="stylesheet" href="/css/sphinx.css" type="text/css" /> + </head> + + <body role="document"> +<div class="header"> + <h1 class="title"> + <a id="top-link" href="../../../"> + <span class="project">groonga</span> + <span class="separator">-</span> + <span class="description">オープンソースのカラムストア機能付き全文検索エンジン</span> + </a> + </h1> + + <div class="facebook-buttons"> + <fb:like href="http://www.facebook.com/pages/groonga/201193596592346" + layout="standard" + width="290"></fb:like> + </div> + <div class="other-language-links"> + + <ul> + <li><a href="../../../../docs/reference/command/request_timeout.html">English</a></li> + </ul> + </div> +</div> + + + <div class="related" role="navigation" aria-label="related navigation"> + <h3>ナビゲーション</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../../genindex.html" title="総合索引" + accesskey="I">索引</a></li> + <li class="right" > + <a href="return_code.html" title="7.3.6. リターンコード" + accesskey="N">次へ</a> |</li> + <li class="right" > + <a href="request_id.html" title="7.3.4. リクエストID" + accesskey="P">前へ</a> |</li> + <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.1ドキュメント</a> »</li> + <li class="nav-item nav-item-1"><a href="../../reference.html" >7. リファレンスマニュアル</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" accesskey="U">7.3. コマンド</a> »</li> + </ul> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body" role="main"> + + <div class="section" id="request-timeout"> +<h1>7.3.5. リクエストタイムアウト<a class="headerlink" href="#request-timeout" title="このヘッドラインへのパーマリンク">¶</a></h1> +<div class="section" id="summary"> +<h2>7.3.5.1. 概要<a class="headerlink" href="#summary" title="このヘッドラインへのパーマリンク">¶</a></h2> +<div class="versionadded"> +<p><span class="versionmodified">バージョン 6.0.2 で追加.</span></p> +</div> +<p>各リクエストにタイムアウトを設定できます。</p> +<p>指定したタイムアウトまでにリクエストが完了しなかった場合、そのリクエストはキャンセルされます。タイムアウトを設定しない場合、そのリクエストが完了するまで処理をします。</p> +<p>リクエストタイムアウト機能はクライアントサイドでタイムアウトを実装しているときに有用です。もし、クライアントサイドだけでタイムアウトを実装していると、クライアントがレスポンスを待つことをやめたあともリクエストを処理し続けます。これは不必要にリソースを消費しています。このリクエストにタイムアウトを設定していれば、じきにこのリクエストはキャンセルされます。</p> +</div> +<div class="section" id="how-to-set-timeout-to-request"> +<h2>7.3.5.2. リクエストにタイムアウトを設定する方法<a class="headerlink" href="#how-to-set-timeout-to-request" title="このヘッドラインへのパーマリンク">¶</a></h2> +<p>すべてのコマンドは <code class="docutils literal"><span class="pre">request_timeout</span></code> パラメーターを受け付けます。 <code class="docutils literal"><span class="pre">request_timeout</span></code> パラメーターを追加することでリクエストにタイムアウトを設定できます。</p> +<p>タイムアウト値の単位は秒です。 <code class="docutils literal"><span class="pre">0.1</span></code> のように小数で指定することで1秒未満のタイムアウトを設定できます。 <code class="docutils literal"><span class="pre">0.1</span></code> は100ミリ秒のタイムアウトという意味です。</p> +<p>以下はリクエストに <code class="docutils literal"><span class="pre">5.5</span></code> 秒のタイムアウトを設定する例です。:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>select Users --request_timeout 5.5 +</pre></div> +</div> +</div> +<div class="section" id="return-code-on-timeout"> +<h2>7.3.5.3. タイムアウト時のリターンコード<a class="headerlink" href="#return-code-on-timeout" title="このヘッドラインへのパーマリンク">¶</a></h2> +<p>リクエストがタイムアウトすると、レスポンスヘッダーの <a class="reference internal" href="return_code.html"><span class="doc">リターンコード</span></a> は <code class="docutils literal"><span class="pre">GRN_CANCEL</span></code> （ <code class="docutils literal"><span class="pre">-77</span></code> ）になります。</p> +<p>以下はタイムアウト時にレスポンス例です。:</p> +<div class="highlight-none"><div class="highlight"><pre><span></span>[ + [ + -77, + 1459846102.63304, + 0.000220775604248047, + "[request-canceler] a request is canceled: <0x7fa0d5d7ed00>" + ] +] +</pre></div> +</div> +<p>レスポンスヘッダーについては <a class="reference internal" href="output_format.html"><span class="doc">出力形式</span></a> を参照してください。</p> +</div> +<div class="section" id="enable-request-timeout-by-default"> +<h2>7.3.5.4. デフォルトでリクエストタイムアウトを有効にする<a class="headerlink" href="#enable-request-timeout-by-default" title="このヘッドラインへのパーマリンク">¶</a></h2> +<p><a class="reference internal" href="../executables/groonga.html"><span class="doc">groonga executable file</span></a> はデフォルトのリクエストタイムアウトを設定する機能があります。デフォルトのリクエストタイムアウトは <a class="reference internal" href="../executables/groonga.html#cmdoption--default-request-timeout"><code class="xref std std-option docutils literal"><span class="pre">--default-request-timeout</span></code></a> で指定します。</p> +<p>デフォルトのリクエストタイムアウトが0より大きい場合、すべてのリクエストはその値をリクエストタイムアウトに使います。</p> +<p>リクエストに <code class="docutils literal"><span class="pre">request_timeout</span></code> パラメーターを指定するとデフォルトのリクエストタイムアウトを上書きできます。もし、デフォルトのリクエストタイムアウトが3秒で <code class="docutils literal"><span class="pre">request_timeout</span></code> パラメーターが1秒なら、そのリクエストは1秒後にキャンセルされます。</p> +</div> +<div class="section" id="see-also"> +<h2>7.3.5.5. 参考<a class="headerlink" href="#see-also" title="このヘッドラインへのパーマリンク">¶</a></h2> +<ul class="simple"> +<li><a class="reference internal" href="return_code.html"><span class="doc">リターンコード</span></a></li> +<li><a class="reference internal" href="output_format.html"><span class="doc">出力形式</span></a></li> +<li><a class="reference internal" href="../commands/request_cancel.html"><span class="doc">request_cancel</span></a></li> +</ul> +</div> +</div> + + + </div> + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> + <h3><a href="../../index.html">目次</a></h3> + <ul> +<li><a class="reference internal" href="#">7.3.5. リクエストタイムアウト</a><ul> +<li><a class="reference internal" href="#summary">7.3.5.1. 概要</a></li> +<li><a class="reference internal" href="#how-to-set-timeout-to-request">7.3.5.2. リクエストにタイムアウトを設定する方法</a></li> +<li><a class="reference internal" href="#return-code-on-timeout">7.3.5.3. タイムアウト時のリターンコード</a></li> +<li><a class="reference internal" href="#enable-request-timeout-by-default">7.3.5.4. デフォルトでリクエストタイムアウトを有効にする</a></li> +<li><a class="reference internal" href="#see-also">7.3.5.5. 参考</a></li> +</ul> +</li> +</ul> + + <h4>前のトピックへ</h4> + <p class="topless"><a href="request_id.html" + title="前の章へ">7.3.4. リクエストID</a></p> + <h4>次のトピックへ</h4> + <p class="topless"><a href="return_code.html" + title="次の章へ">7.3.6. リターンコード</a></p> + <div role="note" aria-label="source link"> + <h3>このページ</h3> + <ul class="this-page-menu"> + <li><a href="../../sources/reference/command/request_timeout.txt" + rel="nofollow">ソースコードを表示（英語）</a></li> + </ul> + </div> +<div id="searchbox" style="display: none" role="search"> + <h3>クイック検索</h3> + <form class="search" action="../../search.html" method="get"> + <input type="text" name="q" /> + <input type="submit" value="検索" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> +<script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related" role="navigation" aria-label="related navigation"> + <h3>ナビゲーション</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="../../genindex.html" title="総合索引" + >索引</a></li> + <li class="right" > + <a href="return_code.html" title="7.3.6. リターンコード" + >次へ</a> |</li> + <li class="right" > + <a href="request_id.html" title="7.3.4. リクエストID" + >前へ</a> |</li> + <li class="nav-item nav-item-0"><a href="../../index.html">Groonga v6.0.1ドキュメント</a> »</li> + <li class="nav-item nav-item-1"><a href="../../reference.html" >7. リファレンスマニュアル</a> »</li> + <li class="nav-item nav-item-2"><a href="../command.html" >7.3. コマンド</a> »</li> + </ul> + </div> + <div class="footer" role="contentinfo"> + © Copyright 2009-2016, Brazil, Inc. + </div> + <script src="http://connect.facebook.net/ja_JP/all.js"></script> + + <script> + FB.init({ + appId : null, + status : true, // check login status + cookie : true, // enable cookies to allow the server to access the session + xfbml : true // parse XFBML + }); + </script> + </body> + +</html> \ No newline at end of file Added: ja/docs/sources/reference/command/request_timeout.txt (+78 -0) 100644 =================================================================== --- /dev/null +++ ja/docs/sources/reference/command/request_timeout.txt 2016-04-19 11:24:43 +0900 (5dad5ec) @@ -0,0 +1,78 @@ +.. -*- rst -*- + +.. highlightlang:: none + +Request timeout +=============== + +Summary +------- + +.. versionadded:: 6.0.2 + +You can set timeout to each request. + +If a request isn't completed until the specified timeout, the request +is canceled. If you don't set timeout, the request is processed until +the request is completed. + +Request timeout feature is useful when you implement timeout on client +side. If you only implement timeout only on client side, the request +keeps processing after client stops waiting response. It uses needless +resources. If you set timeout to the request, the request will be +canceled soon. + +How to set timeout to request +----------------------------- + +All commands accept ``request_timeout`` parameter. You can set timeout +to request by adding ``request_timeout`` parameter. + +Unit of timeout out value is second. You can set timeout less than 1 +second by using decimal such as ``0.1``. ``0.1`` means 100 +milliseconds. + +Here is an example to set ``5.5`` seconds timeout to a request:: + + select Users --request_timeout 5.5 + +Return code on timeout +---------------------- + +If the request is timed out, ``GRN_CANCEL`` (``-77``) +:doc:`return_code` is returned in response header. + +Here is an example response on timeout:: + + [ + [ + -77, + 1459846102.63304, + 0.000220775604248047, + "[request-canceler] a request is canceled: <0x7fa0d5d7ed00>" + ] + ] + +See :doc:`/reference/command/output_format` for response header. + +Enable request timeout by default +--------------------------------- + +:doc:`/reference/executables/groonga` supports enabling request +timeout by default. You can specify the default request timeout by +:option:`--default-request-timeout`. + +If the default request timeout is larger than 0 second, the default +request timeout is used as request timeout for all requests. + +You can overwrite the default request timeout by specifying +``request_timeout`` parameter to request. If the default request +timeout is 3 seconds and ``request_timeout`` parameter is 1 second, +the request is canceled after 1 second. + +See also +-------- + +* :doc:`/reference/command/return_code` +* :doc:`/reference/command/output_format` +* :doc:`/reference/commands/request_cancel` -------------- next part -------------- HTML����������������������������...ダウンロード
