namespace_grpc.html 63 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC PHP: Grpc Namespace Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC PHP
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. </div><!-- top -->
  62. <div class="header">
  63. <div class="summary">
  64. <a href="#nested-classes">Data Structures</a> &#124;
  65. <a href="#var-members">Variables</a> </div>
  66. <div class="headertitle">
  67. <div class="title">Grpc Namespace Reference</div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>Class <a class="el" href="class_grpc_1_1_abstract_call.html">AbstractCall</a>.
  71. <a href="namespace_grpc.html#details">More...</a></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  74. Data Structures</h2></td></tr>
  75. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_abstract_call.html">AbstractCall</a></td></tr>
  76. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_base_stub.html">BaseStub</a></td></tr>
  78. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base class for generated client stubs. <a href="class_grpc_1_1_base_stub.html#details">More...</a><br /></td></tr>
  79. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_bidi_streaming_call.html">BidiStreamingCall</a></td></tr>
  81. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an active call that allows for sending and receiving messages in streams in any order. <a href="class_grpc_1_1_bidi_streaming_call.html#details">More...</a><br /></td></tr>
  82. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_call.html">Call</a></td></tr>
  84. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">class <a class="el" href="class_grpc_1_1_call.html" title="class Call">Call</a> <a href="class_grpc_1_1_call.html#details">More...</a><br /></td></tr>
  85. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_call_credentials.html">CallCredentials</a></td></tr>
  87. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">class <a class="el" href="class_grpc_1_1_call_credentials.html" title="class CallCredentials">CallCredentials</a> <a href="class_grpc_1_1_call_credentials.html#details">More...</a><br /></td></tr>
  88. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_grpc_1_1_call_invoker.html">CallInvoker</a></td></tr>
  90. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="interface_grpc_1_1_call_invoker.html" title="CallInvoker is used to pass the self defined channel into the stub, while intercept each RPC with the...">CallInvoker</a> is used to pass the self defined channel into the stub, while intercept each RPC with the channel accessible. <a href="interface_grpc_1_1_call_invoker.html#details">More...</a><br /></td></tr>
  91. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel.html">Channel</a></td></tr>
  93. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">class <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a> <a href="class_grpc_1_1_channel.html#details">More...</a><br /></td></tr>
  94. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel_credentials.html">ChannelCredentials</a></td></tr>
  96. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">class <a class="el" href="class_grpc_1_1_channel_credentials.html" title="class ChannelCredentials">ChannelCredentials</a> <a href="class_grpc_1_1_channel_credentials.html#details">More...</a><br /></td></tr>
  97. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_client_streaming_call.html">ClientStreamingCall</a></td></tr>
  99. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an active call that sends a stream of messages and then gets a single response. <a href="class_grpc_1_1_client_streaming_call.html#details">More...</a><br /></td></tr>
  100. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_default_call_invoker.html">DefaultCallInvoker</a></td></tr>
  102. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default call invoker in the gRPC stub. <a href="class_grpc_1_1_default_call_invoker.html#details">More...</a><br /></td></tr>
  103. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_interceptor.html">Interceptor</a></td></tr>
  105. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an interceptor that intercept RPC invocations before call starts. <a href="class_grpc_1_1_interceptor.html#details">More...</a><br /></td></tr>
  106. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_rpc_server.html">RpcServer</a></td></tr>
  108. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server.html">Server</a></td></tr>
  110. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">class <a class="el" href="class_grpc_1_1_server.html" title="class Server">Server</a> <a href="class_grpc_1_1_server.html#details">More...</a><br /></td></tr>
  111. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server_credentials.html">ServerCredentials</a></td></tr>
  113. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">class <a class="el" href="class_grpc_1_1_server_credentials.html" title="class ServerCredentials">ServerCredentials</a> <a href="class_grpc_1_1_server_credentials.html#details">More...</a><br /></td></tr>
  114. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server_streaming_call.html">ServerStreamingCall</a></td></tr>
  116. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an active call that sends a single message and then gets a stream of responses. <a href="class_grpc_1_1_server_streaming_call.html#details">More...</a><br /></td></tr>
  117. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_status.html">Status</a></td></tr>
  119. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_timeval.html">Timeval</a></td></tr>
  121. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">class <a class="el" href="class_grpc_1_1_timeval.html" title="class Timeval">Timeval</a> <a href="class_grpc_1_1_timeval.html#details">More...</a><br /></td></tr>
  122. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_unary_call.html">UnaryCall</a></td></tr>
  124. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Represents an active call that sends a single message and then gets a single response. <a href="class_grpc_1_1_unary_call.html#details">More...</a><br /></td></tr>
  125. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table><table class="memberdecls">
  127. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
  128. Variables</h2></td></tr>
  129. <tr class="memitem:aba15b4f16d9a94dae1458b6f89aa5b1e"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#aba15b4f16d9a94dae1458b6f89aa5b1e">CALL_OK</a></td></tr>
  130. <tr class="memdesc:aba15b4f16d9a94dae1458b6f89aa5b1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">everything went ok <a href="namespace_grpc.html#aba15b4f16d9a94dae1458b6f89aa5b1e">More...</a><br /></td></tr>
  131. <tr class="separator:aba15b4f16d9a94dae1458b6f89aa5b1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a6f12e0a446b5933efeb43bb0f33f2de4"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a6f12e0a446b5933efeb43bb0f33f2de4">CALL_ERROR</a></td></tr>
  133. <tr class="memdesc:a6f12e0a446b5933efeb43bb0f33f2de4"><td class="mdescLeft">&#160;</td><td class="mdescRight">something failed, we don't know what <a href="namespace_grpc.html#a6f12e0a446b5933efeb43bb0f33f2de4">More...</a><br /></td></tr>
  134. <tr class="separator:a6f12e0a446b5933efeb43bb0f33f2de4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:a661632eb3cef42aee28e9988962a9640"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a661632eb3cef42aee28e9988962a9640">CALL_ERROR_NOT_ON_SERVER</a></td></tr>
  136. <tr class="memdesc:a661632eb3cef42aee28e9988962a9640"><td class="mdescLeft">&#160;</td><td class="mdescRight">this method is not available on the server <a href="namespace_grpc.html#a661632eb3cef42aee28e9988962a9640">More...</a><br /></td></tr>
  137. <tr class="separator:a661632eb3cef42aee28e9988962a9640"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. <tr class="memitem:a4e684bf33a57f88f69e2738fea230ec6"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a4e684bf33a57f88f69e2738fea230ec6">CALL_ERROR_NOT_ON_CLIENT</a></td></tr>
  139. <tr class="memdesc:a4e684bf33a57f88f69e2738fea230ec6"><td class="mdescLeft">&#160;</td><td class="mdescRight">this method is not available on the client <a href="namespace_grpc.html#a4e684bf33a57f88f69e2738fea230ec6">More...</a><br /></td></tr>
  140. <tr class="separator:a4e684bf33a57f88f69e2738fea230ec6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:aab459c0f556a408f93eb5613f482eb36"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#aab459c0f556a408f93eb5613f482eb36">CALL_ERROR_ALREADY_INVOKED</a></td></tr>
  142. <tr class="memdesc:aab459c0f556a408f93eb5613f482eb36"><td class="mdescLeft">&#160;</td><td class="mdescRight">this method must be called before invoke <a href="namespace_grpc.html#aab459c0f556a408f93eb5613f482eb36">More...</a><br /></td></tr>
  143. <tr class="separator:aab459c0f556a408f93eb5613f482eb36"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:ac812bfda20a324871e244a321bfb17c6"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ac812bfda20a324871e244a321bfb17c6">CALL_ERROR_NOT_INVOKED</a></td></tr>
  145. <tr class="memdesc:ac812bfda20a324871e244a321bfb17c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">this method must be called after invoke <a href="namespace_grpc.html#ac812bfda20a324871e244a321bfb17c6">More...</a><br /></td></tr>
  146. <tr class="separator:ac812bfda20a324871e244a321bfb17c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a830dbf33235c83a06071a24bc94a8f27"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a830dbf33235c83a06071a24bc94a8f27">CALL_ERROR_ALREADY_FINISHED</a></td></tr>
  148. <tr class="memdesc:a830dbf33235c83a06071a24bc94a8f27"><td class="mdescLeft">&#160;</td><td class="mdescRight">this call is already finished (writes_done or write_status has already been called) <a href="namespace_grpc.html#a830dbf33235c83a06071a24bc94a8f27">More...</a><br /></td></tr>
  149. <tr class="separator:a830dbf33235c83a06071a24bc94a8f27"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a2545ae23b42c0626ead78fa57e1acb0e"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a2545ae23b42c0626ead78fa57e1acb0e">CALL_ERROR_TOO_MANY_OPERATIONS</a></td></tr>
  151. <tr class="memdesc:a2545ae23b42c0626ead78fa57e1acb0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">there is already an outstanding read/write operation on the call <a href="namespace_grpc.html#a2545ae23b42c0626ead78fa57e1acb0e">More...</a><br /></td></tr>
  152. <tr class="separator:a2545ae23b42c0626ead78fa57e1acb0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a638ee898d72341600068b52bec0ea0d3"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a638ee898d72341600068b52bec0ea0d3">CALL_ERROR_INVALID_FLAGS</a></td></tr>
  154. <tr class="memdesc:a638ee898d72341600068b52bec0ea0d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">the flags value was illegal for this call <a href="namespace_grpc.html#a638ee898d72341600068b52bec0ea0d3">More...</a><br /></td></tr>
  155. <tr class="separator:a638ee898d72341600068b52bec0ea0d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:affac94238753b51dc4938fcf628e5952"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#affac94238753b51dc4938fcf628e5952">WRITE_BUFFER_HINT</a></td></tr>
  157. <tr class="memdesc:affac94238753b51dc4938fcf628e5952"><td class="mdescLeft">&#160;</td><td class="mdescRight">Hint that the write may be buffered and need not go out on the wire immediately. <a href="namespace_grpc.html#affac94238753b51dc4938fcf628e5952">More...</a><br /></td></tr>
  158. <tr class="separator:affac94238753b51dc4938fcf628e5952"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:ace1fd9a8baa327df3865213f6e50f1de"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ace1fd9a8baa327df3865213f6e50f1de">WRITE_NO_COMPRESS</a></td></tr>
  160. <tr class="memdesc:ace1fd9a8baa327df3865213f6e50f1de"><td class="mdescLeft">&#160;</td><td class="mdescRight">Force compression to be disabled for a particular write (start_write/add_metadata). <a href="namespace_grpc.html#ace1fd9a8baa327df3865213f6e50f1de">More...</a><br /></td></tr>
  161. <tr class="separator:ace1fd9a8baa327df3865213f6e50f1de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:ad5951d2c50713d513e37344a166b9226"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ad5951d2c50713d513e37344a166b9226">STATUS_OK</a></td></tr>
  163. <tr class="memdesc:ad5951d2c50713d513e37344a166b9226"><td class="mdescLeft">&#160;</td><td class="mdescRight">Not an error; returned on success. <a href="namespace_grpc.html#ad5951d2c50713d513e37344a166b9226">More...</a><br /></td></tr>
  164. <tr class="separator:ad5951d2c50713d513e37344a166b9226"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:a5c92cea8804f852d1cfc3f7e03a74d0d"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a5c92cea8804f852d1cfc3f7e03a74d0d">STATUS_CANCELLED</a></td></tr>
  166. <tr class="memdesc:a5c92cea8804f852d1cfc3f7e03a74d0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The operation was cancelled (typically by the caller). <a href="namespace_grpc.html#a5c92cea8804f852d1cfc3f7e03a74d0d">More...</a><br /></td></tr>
  167. <tr class="separator:a5c92cea8804f852d1cfc3f7e03a74d0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:ae27d27849591e84d33ffda9d6fbdcf2f"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ae27d27849591e84d33ffda9d6fbdcf2f">STATUS_UNKNOWN</a></td></tr>
  169. <tr class="memdesc:ae27d27849591e84d33ffda9d6fbdcf2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unknown error. <a href="namespace_grpc.html#ae27d27849591e84d33ffda9d6fbdcf2f">More...</a><br /></td></tr>
  170. <tr class="separator:ae27d27849591e84d33ffda9d6fbdcf2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:ab1ceaf07c0fca00aa5511408a6001de0"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ab1ceaf07c0fca00aa5511408a6001de0">STATUS_INVALID_ARGUMENT</a></td></tr>
  172. <tr class="memdesc:ab1ceaf07c0fca00aa5511408a6001de0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Client specified an invalid argument. <a href="namespace_grpc.html#ab1ceaf07c0fca00aa5511408a6001de0">More...</a><br /></td></tr>
  173. <tr class="separator:ab1ceaf07c0fca00aa5511408a6001de0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:afc349de1812d45926b998695cc083bfd"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#afc349de1812d45926b998695cc083bfd">STATUS_DEADLINE_EXCEEDED</a></td></tr>
  175. <tr class="memdesc:afc349de1812d45926b998695cc083bfd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Deadline expired before operation could complete. <a href="namespace_grpc.html#afc349de1812d45926b998695cc083bfd">More...</a><br /></td></tr>
  176. <tr class="separator:afc349de1812d45926b998695cc083bfd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a643755dab2fb532ce971103391cea02e"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a643755dab2fb532ce971103391cea02e">STATUS_NOT_FOUND</a></td></tr>
  178. <tr class="memdesc:a643755dab2fb532ce971103391cea02e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Some requested entity (e.g., file or directory) was not found. <a href="namespace_grpc.html#a643755dab2fb532ce971103391cea02e">More...</a><br /></td></tr>
  179. <tr class="separator:a643755dab2fb532ce971103391cea02e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  180. <tr class="memitem:ab409d16af8a6e17cb92ccf3b1ab05236"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ab409d16af8a6e17cb92ccf3b1ab05236">STATUS_ALREADY_EXISTS</a></td></tr>
  181. <tr class="memdesc:ab409d16af8a6e17cb92ccf3b1ab05236"><td class="mdescLeft">&#160;</td><td class="mdescRight">Some entity that we attempted to create (e.g., file or directory) already exists. <a href="namespace_grpc.html#ab409d16af8a6e17cb92ccf3b1ab05236">More...</a><br /></td></tr>
  182. <tr class="separator:ab409d16af8a6e17cb92ccf3b1ab05236"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. <tr class="memitem:adad08d063dadc47f96634584529e8126"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#adad08d063dadc47f96634584529e8126">STATUS_PERMISSION_DENIED</a></td></tr>
  184. <tr class="memdesc:adad08d063dadc47f96634584529e8126"><td class="mdescLeft">&#160;</td><td class="mdescRight">The caller does not have permission to execute the specified operation. <a href="namespace_grpc.html#adad08d063dadc47f96634584529e8126">More...</a><br /></td></tr>
  185. <tr class="separator:adad08d063dadc47f96634584529e8126"><td class="memSeparator" colspan="2">&#160;</td></tr>
  186. <tr class="memitem:a3c04fd8871b2bbb7a1d3f0bad88c9e58"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a3c04fd8871b2bbb7a1d3f0bad88c9e58">STATUS_UNAUTHENTICATED</a></td></tr>
  187. <tr class="memdesc:a3c04fd8871b2bbb7a1d3f0bad88c9e58"><td class="mdescLeft">&#160;</td><td class="mdescRight">The request does not have valid authentication credentials for the operation. <a href="namespace_grpc.html#a3c04fd8871b2bbb7a1d3f0bad88c9e58">More...</a><br /></td></tr>
  188. <tr class="separator:a3c04fd8871b2bbb7a1d3f0bad88c9e58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:a0f091c188151dba3b53cd30e04e0bd02"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a0f091c188151dba3b53cd30e04e0bd02">STATUS_RESOURCE_EXHAUSTED</a></td></tr>
  190. <tr class="memdesc:a0f091c188151dba3b53cd30e04e0bd02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. <a href="namespace_grpc.html#a0f091c188151dba3b53cd30e04e0bd02">More...</a><br /></td></tr>
  191. <tr class="separator:a0f091c188151dba3b53cd30e04e0bd02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  192. <tr class="memitem:ae0485212cca13255e0ace3cb9825d0c2"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ae0485212cca13255e0ace3cb9825d0c2">STATUS_FAILED_PRECONDITION</a></td></tr>
  193. <tr class="memdesc:ae0485212cca13255e0ace3cb9825d0c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation was rejected because the system is not in a state required for the operation's execution. <a href="namespace_grpc.html#ae0485212cca13255e0ace3cb9825d0c2">More...</a><br /></td></tr>
  194. <tr class="separator:ae0485212cca13255e0ace3cb9825d0c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  195. <tr class="memitem:a279245936a696d54ce6a0124092c69bb"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a279245936a696d54ce6a0124092c69bb">STATUS_ABORTED</a></td></tr>
  196. <tr class="memdesc:a279245936a696d54ce6a0124092c69bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc. <a href="namespace_grpc.html#a279245936a696d54ce6a0124092c69bb">More...</a><br /></td></tr>
  197. <tr class="separator:a279245936a696d54ce6a0124092c69bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  198. <tr class="memitem:aef5b6dc95d4f65c0a0833e45c98cd965"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#aef5b6dc95d4f65c0a0833e45c98cd965">STATUS_OUT_OF_RANGE</a></td></tr>
  199. <tr class="memdesc:aef5b6dc95d4f65c0a0833e45c98cd965"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation was attempted past the valid range. <a href="namespace_grpc.html#aef5b6dc95d4f65c0a0833e45c98cd965">More...</a><br /></td></tr>
  200. <tr class="separator:aef5b6dc95d4f65c0a0833e45c98cd965"><td class="memSeparator" colspan="2">&#160;</td></tr>
  201. <tr class="memitem:a2402cba05d2a65207abcdadf09a8afcc"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a2402cba05d2a65207abcdadf09a8afcc">STATUS_UNIMPLEMENTED</a></td></tr>
  202. <tr class="memdesc:a2402cba05d2a65207abcdadf09a8afcc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Operation is not implemented or not supported/enabled in this service. <a href="namespace_grpc.html#a2402cba05d2a65207abcdadf09a8afcc">More...</a><br /></td></tr>
  203. <tr class="separator:a2402cba05d2a65207abcdadf09a8afcc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  204. <tr class="memitem:ab4ab5f65ba1708f38deff6bb60d173f9"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ab4ab5f65ba1708f38deff6bb60d173f9">STATUS_INTERNAL</a></td></tr>
  205. <tr class="memdesc:ab4ab5f65ba1708f38deff6bb60d173f9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Internal errors. <a href="namespace_grpc.html#ab4ab5f65ba1708f38deff6bb60d173f9">More...</a><br /></td></tr>
  206. <tr class="separator:ab4ab5f65ba1708f38deff6bb60d173f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  207. <tr class="memitem:a22b1dca4ae9eeafd8525d15913a371d6"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a22b1dca4ae9eeafd8525d15913a371d6">STATUS_UNAVAILABLE</a></td></tr>
  208. <tr class="memdesc:a22b1dca4ae9eeafd8525d15913a371d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The service is currently unavailable. <a href="namespace_grpc.html#a22b1dca4ae9eeafd8525d15913a371d6">More...</a><br /></td></tr>
  209. <tr class="separator:a22b1dca4ae9eeafd8525d15913a371d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  210. <tr class="memitem:a69f3f04e700d069402bbdd1dbca62050"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a69f3f04e700d069402bbdd1dbca62050">STATUS_DATA_LOSS</a></td></tr>
  211. <tr class="memdesc:a69f3f04e700d069402bbdd1dbca62050"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unrecoverable data loss or corruption. <a href="namespace_grpc.html#a69f3f04e700d069402bbdd1dbca62050">More...</a><br /></td></tr>
  212. <tr class="separator:a69f3f04e700d069402bbdd1dbca62050"><td class="memSeparator" colspan="2">&#160;</td></tr>
  213. <tr class="memitem:ab5485f733c0061c5af4a2dcd9ef93485"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ab5485f733c0061c5af4a2dcd9ef93485">OP_SEND_INITIAL_METADATA</a></td></tr>
  214. <tr class="memdesc:ab5485f733c0061c5af4a2dcd9ef93485"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send initial metadata: one and only one instance MUST be sent for each call, unless the call was cancelled - in which case this can be skipped. <a href="namespace_grpc.html#ab5485f733c0061c5af4a2dcd9ef93485">More...</a><br /></td></tr>
  215. <tr class="separator:ab5485f733c0061c5af4a2dcd9ef93485"><td class="memSeparator" colspan="2">&#160;</td></tr>
  216. <tr class="memitem:a2237ae647c50cf9721a343c046879599"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a2237ae647c50cf9721a343c046879599">OP_SEND_MESSAGE</a></td></tr>
  217. <tr class="memdesc:a2237ae647c50cf9721a343c046879599"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a message: 0 or more of these operations can occur for each call. <a href="namespace_grpc.html#a2237ae647c50cf9721a343c046879599">More...</a><br /></td></tr>
  218. <tr class="separator:a2237ae647c50cf9721a343c046879599"><td class="memSeparator" colspan="2">&#160;</td></tr>
  219. <tr class="memitem:abf7a043443542535ee4a39f941791a19"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#abf7a043443542535ee4a39f941791a19">OP_SEND_CLOSE_FROM_CLIENT</a></td></tr>
  220. <tr class="memdesc:abf7a043443542535ee4a39f941791a19"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send a close from the client: one and only one instance MUST be sent from the client, unless the call was cancelled - in which case this can be skipped. <a href="namespace_grpc.html#abf7a043443542535ee4a39f941791a19">More...</a><br /></td></tr>
  221. <tr class="separator:abf7a043443542535ee4a39f941791a19"><td class="memSeparator" colspan="2">&#160;</td></tr>
  222. <tr class="memitem:a329b7e8f6ab80211c43244937d2f066b"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a329b7e8f6ab80211c43244937d2f066b">OP_SEND_STATUS_FROM_SERVER</a></td></tr>
  223. <tr class="memdesc:a329b7e8f6ab80211c43244937d2f066b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send status from the server: one and only one instance MUST be sent from the server unless the call was cancelled - in which case this can be skipped. <a href="namespace_grpc.html#a329b7e8f6ab80211c43244937d2f066b">More...</a><br /></td></tr>
  224. <tr class="separator:a329b7e8f6ab80211c43244937d2f066b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  225. <tr class="memitem:a44bea93ebe65101cd153eb1723b5c8df"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a44bea93ebe65101cd153eb1723b5c8df">OP_RECV_INITIAL_METADATA</a></td></tr>
  226. <tr class="memdesc:a44bea93ebe65101cd153eb1723b5c8df"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive initial metadata: one and only one MUST be made on the client, must not be made on the server. <a href="namespace_grpc.html#a44bea93ebe65101cd153eb1723b5c8df">More...</a><br /></td></tr>
  227. <tr class="separator:a44bea93ebe65101cd153eb1723b5c8df"><td class="memSeparator" colspan="2">&#160;</td></tr>
  228. <tr class="memitem:abd722f249677e393210715a8e78b6d73"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#abd722f249677e393210715a8e78b6d73">OP_RECV_MESSAGE</a></td></tr>
  229. <tr class="memdesc:abd722f249677e393210715a8e78b6d73"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive a message: 0 or more of these operations can occur for each call. <a href="namespace_grpc.html#abd722f249677e393210715a8e78b6d73">More...</a><br /></td></tr>
  230. <tr class="separator:abd722f249677e393210715a8e78b6d73"><td class="memSeparator" colspan="2">&#160;</td></tr>
  231. <tr class="memitem:ac128d591c1154dff27550083d43e4fbc"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ac128d591c1154dff27550083d43e4fbc">OP_RECV_STATUS_ON_CLIENT</a></td></tr>
  232. <tr class="memdesc:ac128d591c1154dff27550083d43e4fbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive status on the client: one and only one must be made on the client. <a href="namespace_grpc.html#ac128d591c1154dff27550083d43e4fbc">More...</a><br /></td></tr>
  233. <tr class="separator:ac128d591c1154dff27550083d43e4fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  234. <tr class="memitem:a01f17ae219509b9217e41a878e9683d4"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a01f17ae219509b9217e41a878e9683d4">OP_RECV_CLOSE_ON_SERVER</a></td></tr>
  235. <tr class="memdesc:a01f17ae219509b9217e41a878e9683d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive close on the server: one and only one must be made on the server. <a href="namespace_grpc.html#a01f17ae219509b9217e41a878e9683d4">More...</a><br /></td></tr>
  236. <tr class="separator:a01f17ae219509b9217e41a878e9683d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  237. <tr class="memitem:a45f9f8ee6023816b530a127bf8b98c1e"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a45f9f8ee6023816b530a127bf8b98c1e">CHANNEL_IDLE</a></td></tr>
  238. <tr class="memdesc:a45f9f8ee6023816b530a127bf8b98c1e"><td class="mdescLeft">&#160;</td><td class="mdescRight">channel is idle <a href="namespace_grpc.html#a45f9f8ee6023816b530a127bf8b98c1e">More...</a><br /></td></tr>
  239. <tr class="separator:a45f9f8ee6023816b530a127bf8b98c1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  240. <tr class="memitem:a57cce2ed93d53b92fa1861e87db8ba2d"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a57cce2ed93d53b92fa1861e87db8ba2d">CHANNEL_CONNECTING</a></td></tr>
  241. <tr class="memdesc:a57cce2ed93d53b92fa1861e87db8ba2d"><td class="mdescLeft">&#160;</td><td class="mdescRight">channel is connecting <a href="namespace_grpc.html#a57cce2ed93d53b92fa1861e87db8ba2d">More...</a><br /></td></tr>
  242. <tr class="separator:a57cce2ed93d53b92fa1861e87db8ba2d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  243. <tr class="memitem:ace72544b0a73a31054a8019c797dd832"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ace72544b0a73a31054a8019c797dd832">CHANNEL_READY</a></td></tr>
  244. <tr class="memdesc:ace72544b0a73a31054a8019c797dd832"><td class="mdescLeft">&#160;</td><td class="mdescRight">channel is ready for work <a href="namespace_grpc.html#ace72544b0a73a31054a8019c797dd832">More...</a><br /></td></tr>
  245. <tr class="separator:ace72544b0a73a31054a8019c797dd832"><td class="memSeparator" colspan="2">&#160;</td></tr>
  246. <tr class="memitem:a5d644d0baad6d761ab0b29efdb95b803"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#a5d644d0baad6d761ab0b29efdb95b803">CHANNEL_TRANSIENT_FAILURE</a></td></tr>
  247. <tr class="memdesc:a5d644d0baad6d761ab0b29efdb95b803"><td class="mdescLeft">&#160;</td><td class="mdescRight">channel has seen a failure but expects to recover <a href="namespace_grpc.html#a5d644d0baad6d761ab0b29efdb95b803">More...</a><br /></td></tr>
  248. <tr class="separator:a5d644d0baad6d761ab0b29efdb95b803"><td class="memSeparator" colspan="2">&#160;</td></tr>
  249. <tr class="memitem:ad53a159e462c8b55e8c770bae0ae4bd0"><td class="memItemLeft" align="right" valign="top">const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_grpc.html#ad53a159e462c8b55e8c770bae0ae4bd0">CHANNEL_FATAL_FAILURE</a></td></tr>
  250. <tr class="memdesc:ad53a159e462c8b55e8c770bae0ae4bd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">channel has seen a failure that it cannot recover from <a href="namespace_grpc.html#ad53a159e462c8b55e8c770bae0ae4bd0">More...</a><br /></td></tr>
  251. <tr class="separator:ad53a159e462c8b55e8c770bae0ae4bd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  252. </table>
  253. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  254. <div class="textblock"><p>Class <a class="el" href="class_grpc_1_1_abstract_call.html">AbstractCall</a>. </p>
  255. <p>This is an experimental and incomplete implementation of gRPC server for PHP.</p>
  256. <p>APIs are <em>definitely</em> going to be changed.</p>
  257. <p>DO NOT USE in production. Class <a class="el" href="class_grpc_1_1_rpc_server.html">RpcServer</a></p>
  258. <p>APIs are <em>definitely</em> going to be changed.</p>
  259. <p>DO NOT USE in production. Class <a class="el" href="class_grpc_1_1_status.html">Status</a> </p>
  260. </div><h2 class="groupheader">Variable Documentation</h2>
  261. <a id="a6f12e0a446b5933efeb43bb0f33f2de4"></a>
  262. <h2 class="memtitle"><span class="permalink"><a href="#a6f12e0a446b5933efeb43bb0f33f2de4">&#9670;&nbsp;</a></span>CALL_ERROR</h2>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <table class="memname">
  266. <tr>
  267. <td class="memname">const Grpc\CALL_ERROR</td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <p>something failed, we don't know what </p>
  272. </div>
  273. </div>
  274. <a id="a830dbf33235c83a06071a24bc94a8f27"></a>
  275. <h2 class="memtitle"><span class="permalink"><a href="#a830dbf33235c83a06071a24bc94a8f27">&#9670;&nbsp;</a></span>CALL_ERROR_ALREADY_FINISHED</h2>
  276. <div class="memitem">
  277. <div class="memproto">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">const Grpc\CALL_ERROR_ALREADY_FINISHED</td>
  281. </tr>
  282. </table>
  283. </div><div class="memdoc">
  284. <p>this call is already finished (writes_done or write_status has already been called) </p>
  285. </div>
  286. </div>
  287. <a id="aab459c0f556a408f93eb5613f482eb36"></a>
  288. <h2 class="memtitle"><span class="permalink"><a href="#aab459c0f556a408f93eb5613f482eb36">&#9670;&nbsp;</a></span>CALL_ERROR_ALREADY_INVOKED</h2>
  289. <div class="memitem">
  290. <div class="memproto">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">const Grpc\CALL_ERROR_ALREADY_INVOKED</td>
  294. </tr>
  295. </table>
  296. </div><div class="memdoc">
  297. <p>this method must be called before invoke </p>
  298. </div>
  299. </div>
  300. <a id="a638ee898d72341600068b52bec0ea0d3"></a>
  301. <h2 class="memtitle"><span class="permalink"><a href="#a638ee898d72341600068b52bec0ea0d3">&#9670;&nbsp;</a></span>CALL_ERROR_INVALID_FLAGS</h2>
  302. <div class="memitem">
  303. <div class="memproto">
  304. <table class="memname">
  305. <tr>
  306. <td class="memname">const Grpc\CALL_ERROR_INVALID_FLAGS</td>
  307. </tr>
  308. </table>
  309. </div><div class="memdoc">
  310. <p>the flags value was illegal for this call </p>
  311. </div>
  312. </div>
  313. <a id="ac812bfda20a324871e244a321bfb17c6"></a>
  314. <h2 class="memtitle"><span class="permalink"><a href="#ac812bfda20a324871e244a321bfb17c6">&#9670;&nbsp;</a></span>CALL_ERROR_NOT_INVOKED</h2>
  315. <div class="memitem">
  316. <div class="memproto">
  317. <table class="memname">
  318. <tr>
  319. <td class="memname">const Grpc\CALL_ERROR_NOT_INVOKED</td>
  320. </tr>
  321. </table>
  322. </div><div class="memdoc">
  323. <p>this method must be called after invoke </p>
  324. </div>
  325. </div>
  326. <a id="a4e684bf33a57f88f69e2738fea230ec6"></a>
  327. <h2 class="memtitle"><span class="permalink"><a href="#a4e684bf33a57f88f69e2738fea230ec6">&#9670;&nbsp;</a></span>CALL_ERROR_NOT_ON_CLIENT</h2>
  328. <div class="memitem">
  329. <div class="memproto">
  330. <table class="memname">
  331. <tr>
  332. <td class="memname">const Grpc\CALL_ERROR_NOT_ON_CLIENT</td>
  333. </tr>
  334. </table>
  335. </div><div class="memdoc">
  336. <p>this method is not available on the client </p>
  337. </div>
  338. </div>
  339. <a id="a661632eb3cef42aee28e9988962a9640"></a>
  340. <h2 class="memtitle"><span class="permalink"><a href="#a661632eb3cef42aee28e9988962a9640">&#9670;&nbsp;</a></span>CALL_ERROR_NOT_ON_SERVER</h2>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <table class="memname">
  344. <tr>
  345. <td class="memname">const Grpc\CALL_ERROR_NOT_ON_SERVER</td>
  346. </tr>
  347. </table>
  348. </div><div class="memdoc">
  349. <p>this method is not available on the server </p>
  350. </div>
  351. </div>
  352. <a id="a2545ae23b42c0626ead78fa57e1acb0e"></a>
  353. <h2 class="memtitle"><span class="permalink"><a href="#a2545ae23b42c0626ead78fa57e1acb0e">&#9670;&nbsp;</a></span>CALL_ERROR_TOO_MANY_OPERATIONS</h2>
  354. <div class="memitem">
  355. <div class="memproto">
  356. <table class="memname">
  357. <tr>
  358. <td class="memname">const Grpc\CALL_ERROR_TOO_MANY_OPERATIONS</td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>there is already an outstanding read/write operation on the call </p>
  363. </div>
  364. </div>
  365. <a id="aba15b4f16d9a94dae1458b6f89aa5b1e"></a>
  366. <h2 class="memtitle"><span class="permalink"><a href="#aba15b4f16d9a94dae1458b6f89aa5b1e">&#9670;&nbsp;</a></span>CALL_OK</h2>
  367. <div class="memitem">
  368. <div class="memproto">
  369. <table class="memname">
  370. <tr>
  371. <td class="memname">const Grpc\CALL_OK</td>
  372. </tr>
  373. </table>
  374. </div><div class="memdoc">
  375. <p>everything went ok </p>
  376. </div>
  377. </div>
  378. <a id="a57cce2ed93d53b92fa1861e87db8ba2d"></a>
  379. <h2 class="memtitle"><span class="permalink"><a href="#a57cce2ed93d53b92fa1861e87db8ba2d">&#9670;&nbsp;</a></span>CHANNEL_CONNECTING</h2>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <table class="memname">
  383. <tr>
  384. <td class="memname">const Grpc\CHANNEL_CONNECTING</td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <p>channel is connecting </p>
  389. </div>
  390. </div>
  391. <a id="ad53a159e462c8b55e8c770bae0ae4bd0"></a>
  392. <h2 class="memtitle"><span class="permalink"><a href="#ad53a159e462c8b55e8c770bae0ae4bd0">&#9670;&nbsp;</a></span>CHANNEL_FATAL_FAILURE</h2>
  393. <div class="memitem">
  394. <div class="memproto">
  395. <table class="memname">
  396. <tr>
  397. <td class="memname">const Grpc\CHANNEL_FATAL_FAILURE</td>
  398. </tr>
  399. </table>
  400. </div><div class="memdoc">
  401. <p>channel has seen a failure that it cannot recover from </p>
  402. </div>
  403. </div>
  404. <a id="a45f9f8ee6023816b530a127bf8b98c1e"></a>
  405. <h2 class="memtitle"><span class="permalink"><a href="#a45f9f8ee6023816b530a127bf8b98c1e">&#9670;&nbsp;</a></span>CHANNEL_IDLE</h2>
  406. <div class="memitem">
  407. <div class="memproto">
  408. <table class="memname">
  409. <tr>
  410. <td class="memname">const Grpc\CHANNEL_IDLE</td>
  411. </tr>
  412. </table>
  413. </div><div class="memdoc">
  414. <p>channel is idle </p>
  415. </div>
  416. </div>
  417. <a id="ace72544b0a73a31054a8019c797dd832"></a>
  418. <h2 class="memtitle"><span class="permalink"><a href="#ace72544b0a73a31054a8019c797dd832">&#9670;&nbsp;</a></span>CHANNEL_READY</h2>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="memname">
  422. <tr>
  423. <td class="memname">const Grpc\CHANNEL_READY</td>
  424. </tr>
  425. </table>
  426. </div><div class="memdoc">
  427. <p>channel is ready for work </p>
  428. </div>
  429. </div>
  430. <a id="a5d644d0baad6d761ab0b29efdb95b803"></a>
  431. <h2 class="memtitle"><span class="permalink"><a href="#a5d644d0baad6d761ab0b29efdb95b803">&#9670;&nbsp;</a></span>CHANNEL_TRANSIENT_FAILURE</h2>
  432. <div class="memitem">
  433. <div class="memproto">
  434. <table class="memname">
  435. <tr>
  436. <td class="memname">const Grpc\CHANNEL_TRANSIENT_FAILURE</td>
  437. </tr>
  438. </table>
  439. </div><div class="memdoc">
  440. <p>channel has seen a failure but expects to recover </p>
  441. </div>
  442. </div>
  443. <a id="a01f17ae219509b9217e41a878e9683d4"></a>
  444. <h2 class="memtitle"><span class="permalink"><a href="#a01f17ae219509b9217e41a878e9683d4">&#9670;&nbsp;</a></span>OP_RECV_CLOSE_ON_SERVER</h2>
  445. <div class="memitem">
  446. <div class="memproto">
  447. <table class="memname">
  448. <tr>
  449. <td class="memname">const Grpc\OP_RECV_CLOSE_ON_SERVER</td>
  450. </tr>
  451. </table>
  452. </div><div class="memdoc">
  453. <p>Receive close on the server: one and only one must be made on the server. </p>
  454. <p>This op completes after the close has been received by the server. This operation always succeeds, meaning ops paired with this operation will also appear to succeed, even though they may not have. </p>
  455. </div>
  456. </div>
  457. <a id="a44bea93ebe65101cd153eb1723b5c8df"></a>
  458. <h2 class="memtitle"><span class="permalink"><a href="#a44bea93ebe65101cd153eb1723b5c8df">&#9670;&nbsp;</a></span>OP_RECV_INITIAL_METADATA</h2>
  459. <div class="memitem">
  460. <div class="memproto">
  461. <table class="memname">
  462. <tr>
  463. <td class="memname">const Grpc\OP_RECV_INITIAL_METADATA</td>
  464. </tr>
  465. </table>
  466. </div><div class="memdoc">
  467. <p>Receive initial metadata: one and only one MUST be made on the client, must not be made on the server. </p>
  468. <p>This op completes after all initial metadata has been read from the peer. </p>
  469. </div>
  470. </div>
  471. <a id="abd722f249677e393210715a8e78b6d73"></a>
  472. <h2 class="memtitle"><span class="permalink"><a href="#abd722f249677e393210715a8e78b6d73">&#9670;&nbsp;</a></span>OP_RECV_MESSAGE</h2>
  473. <div class="memitem">
  474. <div class="memproto">
  475. <table class="memname">
  476. <tr>
  477. <td class="memname">const Grpc\OP_RECV_MESSAGE</td>
  478. </tr>
  479. </table>
  480. </div><div class="memdoc">
  481. <p>Receive a message: 0 or more of these operations can occur for each call. </p>
  482. <p>This op completes after all bytes of the received message have been read, or after a half-close has been received on this call. </p>
  483. </div>
  484. </div>
  485. <a id="ac128d591c1154dff27550083d43e4fbc"></a>
  486. <h2 class="memtitle"><span class="permalink"><a href="#ac128d591c1154dff27550083d43e4fbc">&#9670;&nbsp;</a></span>OP_RECV_STATUS_ON_CLIENT</h2>
  487. <div class="memitem">
  488. <div class="memproto">
  489. <table class="memname">
  490. <tr>
  491. <td class="memname">const Grpc\OP_RECV_STATUS_ON_CLIENT</td>
  492. </tr>
  493. </table>
  494. </div><div class="memdoc">
  495. <p>Receive status on the client: one and only one must be made on the client. </p>
  496. <p>This operation always succeeds, meaning ops paired with this operation will also appear to succeed, even though they may not have. In that case the status will indicate some failure. This op completes after all activity on the call has completed. </p>
  497. </div>
  498. </div>
  499. <a id="abf7a043443542535ee4a39f941791a19"></a>
  500. <h2 class="memtitle"><span class="permalink"><a href="#abf7a043443542535ee4a39f941791a19">&#9670;&nbsp;</a></span>OP_SEND_CLOSE_FROM_CLIENT</h2>
  501. <div class="memitem">
  502. <div class="memproto">
  503. <table class="memname">
  504. <tr>
  505. <td class="memname">const Grpc\OP_SEND_CLOSE_FROM_CLIENT</td>
  506. </tr>
  507. </table>
  508. </div><div class="memdoc">
  509. <p>Send a close from the client: one and only one instance MUST be sent from the client, unless the call was cancelled - in which case this can be skipped. </p>
  510. <p>This op completes after all bytes for the call (including the close) have passed outgoing flow control. </p>
  511. </div>
  512. </div>
  513. <a id="ab5485f733c0061c5af4a2dcd9ef93485"></a>
  514. <h2 class="memtitle"><span class="permalink"><a href="#ab5485f733c0061c5af4a2dcd9ef93485">&#9670;&nbsp;</a></span>OP_SEND_INITIAL_METADATA</h2>
  515. <div class="memitem">
  516. <div class="memproto">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname">const Grpc\OP_SEND_INITIAL_METADATA</td>
  520. </tr>
  521. </table>
  522. </div><div class="memdoc">
  523. <p>Send initial metadata: one and only one instance MUST be sent for each call, unless the call was cancelled - in which case this can be skipped. </p>
  524. <p>This op completes after all bytes of metadata have been accepted by outgoing flow control. </p>
  525. </div>
  526. </div>
  527. <a id="a2237ae647c50cf9721a343c046879599"></a>
  528. <h2 class="memtitle"><span class="permalink"><a href="#a2237ae647c50cf9721a343c046879599">&#9670;&nbsp;</a></span>OP_SEND_MESSAGE</h2>
  529. <div class="memitem">
  530. <div class="memproto">
  531. <table class="memname">
  532. <tr>
  533. <td class="memname">const Grpc\OP_SEND_MESSAGE</td>
  534. </tr>
  535. </table>
  536. </div><div class="memdoc">
  537. <p>Send a message: 0 or more of these operations can occur for each call. </p>
  538. <p>This op completes after all bytes for the message have been accepted by outgoing flow control. </p>
  539. </div>
  540. </div>
  541. <a id="a329b7e8f6ab80211c43244937d2f066b"></a>
  542. <h2 class="memtitle"><span class="permalink"><a href="#a329b7e8f6ab80211c43244937d2f066b">&#9670;&nbsp;</a></span>OP_SEND_STATUS_FROM_SERVER</h2>
  543. <div class="memitem">
  544. <div class="memproto">
  545. <table class="memname">
  546. <tr>
  547. <td class="memname">const Grpc\OP_SEND_STATUS_FROM_SERVER</td>
  548. </tr>
  549. </table>
  550. </div><div class="memdoc">
  551. <p>Send status from the server: one and only one instance MUST be sent from the server unless the call was cancelled - in which case this can be skipped. </p>
  552. <p>This op completes after all bytes for the call (including the status) have passed outgoing flow control. </p>
  553. </div>
  554. </div>
  555. <a id="a279245936a696d54ce6a0124092c69bb"></a>
  556. <h2 class="memtitle"><span class="permalink"><a href="#a279245936a696d54ce6a0124092c69bb">&#9670;&nbsp;</a></span>STATUS_ABORTED</h2>
  557. <div class="memitem">
  558. <div class="memproto">
  559. <table class="memname">
  560. <tr>
  561. <td class="memname">const Grpc\STATUS_ABORTED</td>
  562. </tr>
  563. </table>
  564. </div><div class="memdoc">
  565. <p>The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc. </p>
  566. <p>See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE. </p>
  567. </div>
  568. </div>
  569. <a id="ab409d16af8a6e17cb92ccf3b1ab05236"></a>
  570. <h2 class="memtitle"><span class="permalink"><a href="#ab409d16af8a6e17cb92ccf3b1ab05236">&#9670;&nbsp;</a></span>STATUS_ALREADY_EXISTS</h2>
  571. <div class="memitem">
  572. <div class="memproto">
  573. <table class="memname">
  574. <tr>
  575. <td class="memname">const Grpc\STATUS_ALREADY_EXISTS</td>
  576. </tr>
  577. </table>
  578. </div><div class="memdoc">
  579. <p>Some entity that we attempted to create (e.g., file or directory) already exists. </p>
  580. </div>
  581. </div>
  582. <a id="a5c92cea8804f852d1cfc3f7e03a74d0d"></a>
  583. <h2 class="memtitle"><span class="permalink"><a href="#a5c92cea8804f852d1cfc3f7e03a74d0d">&#9670;&nbsp;</a></span>STATUS_CANCELLED</h2>
  584. <div class="memitem">
  585. <div class="memproto">
  586. <table class="memname">
  587. <tr>
  588. <td class="memname">const Grpc\STATUS_CANCELLED</td>
  589. </tr>
  590. </table>
  591. </div><div class="memdoc">
  592. <p>The operation was cancelled (typically by the caller). </p>
  593. </div>
  594. </div>
  595. <a id="a69f3f04e700d069402bbdd1dbca62050"></a>
  596. <h2 class="memtitle"><span class="permalink"><a href="#a69f3f04e700d069402bbdd1dbca62050">&#9670;&nbsp;</a></span>STATUS_DATA_LOSS</h2>
  597. <div class="memitem">
  598. <div class="memproto">
  599. <table class="memname">
  600. <tr>
  601. <td class="memname">const Grpc\STATUS_DATA_LOSS</td>
  602. </tr>
  603. </table>
  604. </div><div class="memdoc">
  605. <p>Unrecoverable data loss or corruption. </p>
  606. </div>
  607. </div>
  608. <a id="afc349de1812d45926b998695cc083bfd"></a>
  609. <h2 class="memtitle"><span class="permalink"><a href="#afc349de1812d45926b998695cc083bfd">&#9670;&nbsp;</a></span>STATUS_DEADLINE_EXCEEDED</h2>
  610. <div class="memitem">
  611. <div class="memproto">
  612. <table class="memname">
  613. <tr>
  614. <td class="memname">const Grpc\STATUS_DEADLINE_EXCEEDED</td>
  615. </tr>
  616. </table>
  617. </div><div class="memdoc">
  618. <p>Deadline expired before operation could complete. </p>
  619. <p>For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. </p>
  620. </div>
  621. </div>
  622. <a id="ae0485212cca13255e0ace3cb9825d0c2"></a>
  623. <h2 class="memtitle"><span class="permalink"><a href="#ae0485212cca13255e0ace3cb9825d0c2">&#9670;&nbsp;</a></span>STATUS_FAILED_PRECONDITION</h2>
  624. <div class="memitem">
  625. <div class="memproto">
  626. <table class="memname">
  627. <tr>
  628. <td class="memname">const Grpc\STATUS_FAILED_PRECONDITION</td>
  629. </tr>
  630. </table>
  631. </div><div class="memdoc">
  632. <p>Operation was rejected because the system is not in a state required for the operation's execution. </p>
  633. <p>For example, directory to be deleted may be non-empty, an rmdir operation is applied to a non-directory, etc.</p>
  634. <p>A litmus test that may help a service implementor in deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE: (a) Use UNAVAILABLE if the client can retry just the failing call. (b) Use ABORTED if the client should retry at a higher-level (e.g., restarting a read-modify-write sequence). (c) Use FAILED_PRECONDITION if the client should not retry until the system state has been explicitly fixed. E.g., if an "rmdir" fails because the directory is non-empty, FAILED_PRECONDITION should be returned since the client should not retry unless they have first fixed up the directory by deleting files from it. (d) Use FAILED_PRECONDITION if the client performs conditional REST Get/Update/Delete on a resource and the resource on the server does not match the condition. E.g., conflicting read-modify-write on the same resource. </p>
  635. </div>
  636. </div>
  637. <a id="ab4ab5f65ba1708f38deff6bb60d173f9"></a>
  638. <h2 class="memtitle"><span class="permalink"><a href="#ab4ab5f65ba1708f38deff6bb60d173f9">&#9670;&nbsp;</a></span>STATUS_INTERNAL</h2>
  639. <div class="memitem">
  640. <div class="memproto">
  641. <table class="memname">
  642. <tr>
  643. <td class="memname">const Grpc\STATUS_INTERNAL</td>
  644. </tr>
  645. </table>
  646. </div><div class="memdoc">
  647. <p>Internal errors. </p>
  648. <p>Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. </p>
  649. </div>
  650. </div>
  651. <a id="ab1ceaf07c0fca00aa5511408a6001de0"></a>
  652. <h2 class="memtitle"><span class="permalink"><a href="#ab1ceaf07c0fca00aa5511408a6001de0">&#9670;&nbsp;</a></span>STATUS_INVALID_ARGUMENT</h2>
  653. <div class="memitem">
  654. <div class="memproto">
  655. <table class="memname">
  656. <tr>
  657. <td class="memname">const Grpc\STATUS_INVALID_ARGUMENT</td>
  658. </tr>
  659. </table>
  660. </div><div class="memdoc">
  661. <p>Client specified an invalid argument. </p>
  662. <p>Note that this differs from FAILED_PRECONDITION. INVALID_ARGUMENT indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). </p>
  663. </div>
  664. </div>
  665. <a id="a643755dab2fb532ce971103391cea02e"></a>
  666. <h2 class="memtitle"><span class="permalink"><a href="#a643755dab2fb532ce971103391cea02e">&#9670;&nbsp;</a></span>STATUS_NOT_FOUND</h2>
  667. <div class="memitem">
  668. <div class="memproto">
  669. <table class="memname">
  670. <tr>
  671. <td class="memname">const Grpc\STATUS_NOT_FOUND</td>
  672. </tr>
  673. </table>
  674. </div><div class="memdoc">
  675. <p>Some requested entity (e.g., file or directory) was not found. </p>
  676. </div>
  677. </div>
  678. <a id="ad5951d2c50713d513e37344a166b9226"></a>
  679. <h2 class="memtitle"><span class="permalink"><a href="#ad5951d2c50713d513e37344a166b9226">&#9670;&nbsp;</a></span>STATUS_OK</h2>
  680. <div class="memitem">
  681. <div class="memproto">
  682. <table class="memname">
  683. <tr>
  684. <td class="memname">const Grpc\STATUS_OK</td>
  685. </tr>
  686. </table>
  687. </div><div class="memdoc">
  688. <p>Not an error; returned on success. </p>
  689. </div>
  690. </div>
  691. <a id="aef5b6dc95d4f65c0a0833e45c98cd965"></a>
  692. <h2 class="memtitle"><span class="permalink"><a href="#aef5b6dc95d4f65c0a0833e45c98cd965">&#9670;&nbsp;</a></span>STATUS_OUT_OF_RANGE</h2>
  693. <div class="memitem">
  694. <div class="memproto">
  695. <table class="memname">
  696. <tr>
  697. <td class="memname">const Grpc\STATUS_OUT_OF_RANGE</td>
  698. </tr>
  699. </table>
  700. </div><div class="memdoc">
  701. <p>Operation was attempted past the valid range. </p>
  702. <p>E.g., seeking or reading past end of file.</p>
  703. <p>Unlike INVALID_ARGUMENT, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate INVALID_ARGUMENT if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OUT_OF_RANGE if asked to read from an offset past the current file size.</p>
  704. <p>There is a fair bit of overlap between FAILED_PRECONDITION and OUT_OF_RANGE. We recommend using OUT_OF_RANGE (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OUT_OF_RANGE error to detect when they are done. </p>
  705. </div>
  706. </div>
  707. <a id="adad08d063dadc47f96634584529e8126"></a>
  708. <h2 class="memtitle"><span class="permalink"><a href="#adad08d063dadc47f96634584529e8126">&#9670;&nbsp;</a></span>STATUS_PERMISSION_DENIED</h2>
  709. <div class="memitem">
  710. <div class="memproto">
  711. <table class="memname">
  712. <tr>
  713. <td class="memname">const Grpc\STATUS_PERMISSION_DENIED</td>
  714. </tr>
  715. </table>
  716. </div><div class="memdoc">
  717. <p>The caller does not have permission to execute the specified operation. </p>
  718. <p>PERMISSION_DENIED must not be used for rejections caused by exhausting some resource (use RESOURCE_EXHAUSTED instead for those errors). PERMISSION_DENIED must not be used if the caller can not be identified (use UNAUTHENTICATED instead for those errors). </p>
  719. </div>
  720. </div>
  721. <a id="a0f091c188151dba3b53cd30e04e0bd02"></a>
  722. <h2 class="memtitle"><span class="permalink"><a href="#a0f091c188151dba3b53cd30e04e0bd02">&#9670;&nbsp;</a></span>STATUS_RESOURCE_EXHAUSTED</h2>
  723. <div class="memitem">
  724. <div class="memproto">
  725. <table class="memname">
  726. <tr>
  727. <td class="memname">const Grpc\STATUS_RESOURCE_EXHAUSTED</td>
  728. </tr>
  729. </table>
  730. </div><div class="memdoc">
  731. <p>Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. </p>
  732. </div>
  733. </div>
  734. <a id="a3c04fd8871b2bbb7a1d3f0bad88c9e58"></a>
  735. <h2 class="memtitle"><span class="permalink"><a href="#a3c04fd8871b2bbb7a1d3f0bad88c9e58">&#9670;&nbsp;</a></span>STATUS_UNAUTHENTICATED</h2>
  736. <div class="memitem">
  737. <div class="memproto">
  738. <table class="memname">
  739. <tr>
  740. <td class="memname">const Grpc\STATUS_UNAUTHENTICATED</td>
  741. </tr>
  742. </table>
  743. </div><div class="memdoc">
  744. <p>The request does not have valid authentication credentials for the operation. </p>
  745. </div>
  746. </div>
  747. <a id="a22b1dca4ae9eeafd8525d15913a371d6"></a>
  748. <h2 class="memtitle"><span class="permalink"><a href="#a22b1dca4ae9eeafd8525d15913a371d6">&#9670;&nbsp;</a></span>STATUS_UNAVAILABLE</h2>
  749. <div class="memitem">
  750. <div class="memproto">
  751. <table class="memname">
  752. <tr>
  753. <td class="memname">const Grpc\STATUS_UNAVAILABLE</td>
  754. </tr>
  755. </table>
  756. </div><div class="memdoc">
  757. <p>The service is currently unavailable. </p>
  758. <p>This is a most likely a transient condition and may be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations.</p>
  759. <p>WARNING: Although data MIGHT not have been transmitted when this status occurs, there is NOT A GUARANTEE that the server has not seen anything. So in general it is unsafe to retry on this status code if the call is non-idempotent.</p>
  760. <p>See litmus test above for deciding between FAILED_PRECONDITION, ABORTED, and UNAVAILABLE. </p>
  761. </div>
  762. </div>
  763. <a id="a2402cba05d2a65207abcdadf09a8afcc"></a>
  764. <h2 class="memtitle"><span class="permalink"><a href="#a2402cba05d2a65207abcdadf09a8afcc">&#9670;&nbsp;</a></span>STATUS_UNIMPLEMENTED</h2>
  765. <div class="memitem">
  766. <div class="memproto">
  767. <table class="memname">
  768. <tr>
  769. <td class="memname">const Grpc\STATUS_UNIMPLEMENTED</td>
  770. </tr>
  771. </table>
  772. </div><div class="memdoc">
  773. <p>Operation is not implemented or not supported/enabled in this service. </p>
  774. </div>
  775. </div>
  776. <a id="ae27d27849591e84d33ffda9d6fbdcf2f"></a>
  777. <h2 class="memtitle"><span class="permalink"><a href="#ae27d27849591e84d33ffda9d6fbdcf2f">&#9670;&nbsp;</a></span>STATUS_UNKNOWN</h2>
  778. <div class="memitem">
  779. <div class="memproto">
  780. <table class="memname">
  781. <tr>
  782. <td class="memname">const Grpc\STATUS_UNKNOWN</td>
  783. </tr>
  784. </table>
  785. </div><div class="memdoc">
  786. <p>Unknown error. </p>
  787. <p>An example of where this error may be returned is if a <a class="el" href="class_grpc_1_1_status.html">Status</a> value received from another address space belongs to an error-space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. </p>
  788. </div>
  789. </div>
  790. <a id="affac94238753b51dc4938fcf628e5952"></a>
  791. <h2 class="memtitle"><span class="permalink"><a href="#affac94238753b51dc4938fcf628e5952">&#9670;&nbsp;</a></span>WRITE_BUFFER_HINT</h2>
  792. <div class="memitem">
  793. <div class="memproto">
  794. <table class="memname">
  795. <tr>
  796. <td class="memname">const Grpc\WRITE_BUFFER_HINT</td>
  797. </tr>
  798. </table>
  799. </div><div class="memdoc">
  800. <p>Hint that the write may be buffered and need not go out on the wire immediately. </p>
  801. <p>GRPC is free to buffer the message until the next non-buffered write, or until writes_done, but it need not buffer completely or at all. </p>
  802. </div>
  803. </div>
  804. <a id="ace1fd9a8baa327df3865213f6e50f1de"></a>
  805. <h2 class="memtitle"><span class="permalink"><a href="#ace1fd9a8baa327df3865213f6e50f1de">&#9670;&nbsp;</a></span>WRITE_NO_COMPRESS</h2>
  806. <div class="memitem">
  807. <div class="memproto">
  808. <table class="memname">
  809. <tr>
  810. <td class="memname">const Grpc\WRITE_NO_COMPRESS</td>
  811. </tr>
  812. </table>
  813. </div><div class="memdoc">
  814. <p>Force compression to be disabled for a particular write (start_write/add_metadata). </p>
  815. <p>Illegal on invoke/accept. </p>
  816. </div>
  817. </div>
  818. </div><!-- contents -->
  819. <!-- start footer part -->
  820. <hr class="footer"/><address class="footer"><small>
  821. Generated on Wed Mar 3 2021 19:20:18 for GRPC PHP by &#160;<a href="http://www.doxygen.org/index.html">
  822. <img class="footer" src="doxygen.png" alt="doxygen"/>
  823. </a> 1.8.17
  824. </small></address>
  825. </body>
  826. </html>