| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>ServerCallHandler (grpc-all 1.77.0 API)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../jquery/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| <script type="text/javascript" src="../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../jquery/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="../../jquery/jquery-ui.min.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ServerCallHandler (grpc-all 1.77.0 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ServerCallHandler.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">io.grpc</a></div> |
| <h2 title="Interface ServerCallHandler" class="title">Interface ServerCallHandler<RequestT,​ResponseT></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <pre>@ThreadSafe |
| public interface <span class="typeNameLabel">ServerCallHandler<RequestT,​ResponseT></span></pre> |
| <div class="block">Interface to initiate processing of incoming remote calls. Advanced applications and generated |
| code will implement this interface to allows <a href="Server.html" title="class in io.grpc"><code>Server</code></a>s to invoke service methods.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="ServerCall.Listener.html" title="class in io.grpc">ServerCall.Listener</a><<a href="ServerCallHandler.html" title="type parameter in ServerCallHandler">RequestT</a>></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#startCall(io.grpc.ServerCall,io.grpc.Metadata)">startCall</a></span>​(<a href="ServerCall.html" title="class in io.grpc">ServerCall</a><<a href="ServerCallHandler.html" title="type parameter in ServerCallHandler">RequestT</a>,​<a href="ServerCallHandler.html" title="type parameter in ServerCallHandler">ResponseT</a>> call, |
| <a href="Metadata.html" title="class in io.grpc">Metadata</a> headers)</code></th> |
| <td class="colLast"> |
| <div class="block">Starts asynchronous processing of an incoming call.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="startCall(io.grpc.ServerCall,io.grpc.Metadata)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>startCall</h4> |
| <pre class="methodSignature"><a href="ServerCall.Listener.html" title="class in io.grpc">ServerCall.Listener</a><<a href="ServerCallHandler.html" title="type parameter in ServerCallHandler">RequestT</a>> startCall​(<a href="ServerCall.html" title="class in io.grpc">ServerCall</a><<a href="ServerCallHandler.html" title="type parameter in ServerCallHandler">RequestT</a>,​<a href="ServerCallHandler.html" title="type parameter in ServerCallHandler">ResponseT</a>> call, |
| <a href="Metadata.html" title="class in io.grpc">Metadata</a> headers)</pre> |
| <div class="block">Starts asynchronous processing of an incoming call. |
| |
| <p>Callers of this method transfer their ownership of the non-thread-safe <a href="ServerCall.html" title="class in io.grpc"><code>ServerCall</code></a> |
| and <a href="Metadata.html" title="class in io.grpc"><code>Metadata</code></a> arguments to the <a href="ServerCallHandler.html" title="interface in io.grpc"><code>ServerCallHandler</code></a> implementation for processing. |
| Ownership means that the implementation may invoke methods on <code>call</code> and <code>headers</code> |
| while <a href="#startCall(io.grpc.ServerCall,io.grpc.Metadata)"><code>startCall(io.grpc.ServerCall<RequestT, ResponseT>, io.grpc.Metadata)</code></a> runs and at any time after it returns normally. On the other hand, if |
| <a href="#startCall(io.grpc.ServerCall,io.grpc.Metadata)"><code>startCall(io.grpc.ServerCall<RequestT, ResponseT>, io.grpc.Metadata)</code></a> throws, ownership of <code>call</code> and <code>headers</code> reverts to the caller |
| and the implementation loses the right to call methods on these objects (from some other |
| thread, say). |
| |
| <p>Ownership also includes the responsibility to eventually close <code>call</code>. In particular, |
| if <a href="#startCall(io.grpc.ServerCall,io.grpc.Metadata)"><code>startCall(io.grpc.ServerCall<RequestT, ResponseT>, io.grpc.Metadata)</code></a> throws an exception, the caller must handle it by closing <code>call</code> |
| with an error. Since <code>call</code> can only be closed once, an implementation can report errors |
| either to <a href="ServerCall.html#close(io.grpc.Status,io.grpc.Metadata)"><code>ServerCall.close(io.grpc.Status, io.grpc.Metadata)</code></a> for itself or by throwing an exception, but not both. |
| |
| <p>Returns a non-<code>null</code> listener for the incoming call. Callers of this method must |
| arrange for events associated with <code>call</code> to be delivered there.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>call</code> - object for responding to the remote client.</dd> |
| <dd><code>headers</code> - request headers received from the client but open to modification by an owner</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>listener for processing incoming request messages for <code>call</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ServerCallHandler.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| </footer> |
| </body> |
| </html> |
