diff options
Diffstat (limited to 'doc/ref/c++.internal/html/classgrpc_1_1_server.html')
| -rw-r--r-- | doc/ref/c++.internal/html/classgrpc_1_1_server.html | 72 |
1 files changed, 69 insertions, 3 deletions
diff --git a/doc/ref/c++.internal/html/classgrpc_1_1_server.html b/doc/ref/c++.internal/html/classgrpc_1_1_server.html index 0a8831f4cd..1053b8e97a 100644 --- a/doc/ref/c++.internal/html/classgrpc_1_1_server.html +++ b/doc/ref/c++.internal/html/classgrpc_1_1_server.html @@ -23,7 +23,7 @@ <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">GRPC C++ -  <span id="projectnumber">0.10.0.0</span> +  <span id="projectnumber">0.11.0.0</span> </div> </td> </tr> @@ -96,6 +96,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div><!--header--> <div class="contents"> +<p>Models a gRPC server. + <a href="classgrpc_1_1_server.html#details">More...</a></p> + <p><code>#include <<a class="el" href="server_8h_source.html">server.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> @@ -104,14 +107,26 @@ Data Structures</h2></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1_sync_request.html">SyncRequest</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1_unimplemented_async_request.html">UnimplementedAsyncRequest</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1_unimplemented_async_request_context.html">UnimplementedAsyncRequestContext</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_1_1_unimplemented_async_response.html">UnimplementedAsyncResponse</a></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:aa13591ff1bb2c5d871778189b391feb2"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#aa13591ff1bb2c5d871778189b391feb2">~Server</a> ()</td></tr> <tr class="separator:aa13591ff1bb2c5d871778189b391feb2"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aeadfd93954df3fdfe1ddcccc4e681f17"><td class="memTemplParams" colspan="2">template<class T > </td></tr> +<tr class="memitem:aeadfd93954df3fdfe1ddcccc4e681f17"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#aeadfd93954df3fdfe1ddcccc4e681f17">Shutdown</a> (const T &deadline)</td></tr> +<tr class="memdesc:aeadfd93954df3fdfe1ddcccc4e681f17"><td class="mdescLeft"> </td><td class="mdescRight">Shutdown the server, blocking until all rpc processing finishes. <a href="#aeadfd93954df3fdfe1ddcccc4e681f17">More...</a><br/></td></tr> +<tr class="separator:aeadfd93954df3fdfe1ddcccc4e681f17"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a777a9c8873ae4969585083e0e62482dc"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a777a9c8873ae4969585083e0e62482dc">Shutdown</a> ()</td></tr> +<tr class="memdesc:a777a9c8873ae4969585083e0e62482dc"><td class="mdescLeft"> </td><td class="mdescRight">Shutdown the server, waiting for all rpc processing to finish. <a href="#a777a9c8873ae4969585083e0e62482dc">More...</a><br/></td></tr> <tr class="separator:a777a9c8873ae4969585083e0e62482dc"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a6f1ec2700c94637813178a5b5f71d6d5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a6f1ec2700c94637813178a5b5f71d6d5">Wait</a> ()</td></tr> +<tr class="memdesc:a6f1ec2700c94637813178a5b5f71d6d5"><td class="mdescLeft"> </td><td class="mdescRight">Block waiting for all work to complete. <a href="#a6f1ec2700c94637813178a5b5f71d6d5">More...</a><br/></td></tr> <tr class="separator:a6f1ec2700c94637813178a5b5f71d6d5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classgrpc_1_1_grpc_library"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_grpc_library')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1_grpc_library.html">grpc::GrpcLibrary</a></td></tr> <tr class="memitem:af026f86430cf235d7eaf532231a44528 inherit pub_methods_classgrpc_1_1_grpc_library"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_grpc_library.html#af026f86430cf235d7eaf532231a44528">GrpcLibrary</a> ()</td></tr> @@ -128,7 +143,10 @@ Friends</h2></td></tr> <tr class="memitem:a8c2db91f514d534f06396d90c1b1f2c4"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server.html#a8c2db91f514d534f06396d90c1b1f2c4">ServerBuilder</a></td></tr> <tr class="separator:a8c2db91f514d534f06396d90c1b1f2c4"><td class="memSeparator" colspan="2"> </td></tr> </table> -<h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Models a gRPC server. </p> +<p>Servers are configured and started via <em><a class="el" href="classgrpc_1_1_server_builder.html" title="A builder class for the creation and startup of grpc::Server instances. ">grpc::ServerBuilder</a></em>. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="aa13591ff1bb2c5d871778189b391feb2"></a> <div class="memitem"> <div class="memproto"> @@ -145,9 +163,47 @@ Friends</h2></td></tr> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="aeadfd93954df3fdfe1ddcccc4e681f17"></a> +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class T > </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void grpc::Server::Shutdown </td> + <td>(</td> + <td class="paramtype">const T & </td> + <td class="paramname"><em>deadline</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Shutdown the server, blocking until all rpc processing finishes. </p> +<p>Forcefully terminate pending calls after <em>deadline</em> expires.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">deadline</td><td>How long to wait until pending rpcs are forcefully terminated. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> <a class="anchor" id="a777a9c8873ae4969585083e0e62482dc"></a> <div class="memitem"> <div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">void grpc::Server::Shutdown </td> @@ -156,8 +212,15 @@ Friends</h2></td></tr> <td></td> </tr> </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> </div><div class="memdoc"> +<p>Shutdown the server, waiting for all rpc processing to finish. </p> + </div> </div> <a class="anchor" id="a6f1ec2700c94637813178a5b5f71d6d5"></a> @@ -173,6 +236,9 @@ Friends</h2></td></tr> </table> </div><div class="memdoc"> +<p>Block waiting for all work to complete. </p> +<dl class="section warning"><dt>Warning</dt><dd>The server must be either shutting down or some other thread must call <em>Shutdown</em> for this function to ever return. </dd></dl> + </div> </div> <h2 class="groupheader">Friends And Related Function Documentation</h2> @@ -243,7 +309,7 @@ Friends</h2></td></tr> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Wed Aug 5 2015 08:17:08 for GRPC C++ by  <a href="http://www.doxygen.org/index.html"> +Generated on Thu Sep 3 2015 09:44:14 for GRPC C++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.6 </small></address> |