grpc/php/class_grpc_1_1_server_conte...

274 lines
12 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC PHP: Grpc\ServerContext Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">GRPC PHP
&#160;<span id="projectnumber">1.58.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_grpc.html">Grpc</a></li><li class="navelem"><a class="el" href="class_grpc_1_1_server_context.html">ServerContext</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Grpc\ServerContext Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>This is an experimental and incomplete implementation of gRPC server for PHP.
<a href="class_grpc_1_1_server_context.html#details">More...</a></p>
<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:a5547318a209d3d6e3883318235ed6464"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server_context.html#a5547318a209d3d6e3883318235ed6464">__construct</a> ($event)</td></tr>
<tr class="separator:a5547318a209d3d6e3883318235ed6464"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1504ab1d5956772056a7e96d30e0788f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server_context.html#a1504ab1d5956772056a7e96d30e0788f">clientMetadata</a> ()</td></tr>
<tr class="separator:a1504ab1d5956772056a7e96d30e0788f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aecce38993cd2c0b1fb2535b9d61bd3e6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server_context.html#aecce38993cd2c0b1fb2535b9d61bd3e6">deadline</a> ()</td></tr>
<tr class="separator:aecce38993cd2c0b1fb2535b9d61bd3e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adad18109756e7a7d3595653afe1ee5e6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server_context.html#adad18109756e7a7d3595653afe1ee5e6">host</a> ()</td></tr>
<tr class="separator:adad18109756e7a7d3595653afe1ee5e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3fc17d19c25c19e171df1904634b67f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server_context.html#ac3fc17d19c25c19e171df1904634b67f">method</a> ()</td></tr>
<tr class="separator:ac3fc17d19c25c19e171df1904634b67f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab723a1ac96b2c8c7b0d67b81317fad94"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server_context.html#ab723a1ac96b2c8c7b0d67b81317fad94">setInitialMetadata</a> ($<a class="el" href="class_grpc_1_1_server_context.html#a13bc680522b811e7fc5518736f443786">initialMetadata</a>)</td></tr>
<tr class="separator:ab723a1ac96b2c8c7b0d67b81317fad94"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13bc680522b811e7fc5518736f443786"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server_context.html#a13bc680522b811e7fc5518736f443786">initialMetadata</a> ()</td></tr>
<tr class="separator:a13bc680522b811e7fc5518736f443786"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a850c43a13b003d034020bbaaaa942808"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server_context.html#a850c43a13b003d034020bbaaaa942808">setStatus</a> ($<a class="el" href="class_grpc_1_1_server_context.html#aaecd6027bc712b9a6c6b59d433b2894b">status</a>)</td></tr>
<tr class="separator:a850c43a13b003d034020bbaaaa942808"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaecd6027bc712b9a6c6b59d433b2894b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_server_context.html#aaecd6027bc712b9a6c6b59d433b2894b">status</a> ()</td></tr>
<tr class="separator:aaecd6027bc712b9a6c6b59d433b2894b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This is an experimental and incomplete implementation of gRPC server for PHP. </p>
<p>APIs are <em>definitely</em> going to be changed.</p>
<p>DO NOT USE in production. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5547318a209d3d6e3883318235ed6464"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5547318a209d3d6e3883318235ed6464">&#9670;&nbsp;</a></span>__construct()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Grpc\ServerContext::__construct </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$event</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1504ab1d5956772056a7e96d30e0788f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1504ab1d5956772056a7e96d30e0788f">&#9670;&nbsp;</a></span>clientMetadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Grpc\ServerContext::clientMetadata </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aecce38993cd2c0b1fb2535b9d61bd3e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecce38993cd2c0b1fb2535b9d61bd3e6">&#9670;&nbsp;</a></span>deadline()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Grpc\ServerContext::deadline </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adad18109756e7a7d3595653afe1ee5e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adad18109756e7a7d3595653afe1ee5e6">&#9670;&nbsp;</a></span>host()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Grpc\ServerContext::host </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a13bc680522b811e7fc5518736f443786"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13bc680522b811e7fc5518736f443786">&#9670;&nbsp;</a></span>initialMetadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Grpc\ServerContext::initialMetadata </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac3fc17d19c25c19e171df1904634b67f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3fc17d19c25c19e171df1904634b67f">&#9670;&nbsp;</a></span>method()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Grpc\ServerContext::method </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab723a1ac96b2c8c7b0d67b81317fad94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab723a1ac96b2c8c7b0d67b81317fad94">&#9670;&nbsp;</a></span>setInitialMetadata()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Grpc\ServerContext::setInitialMetadata </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$initialMetadata</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a850c43a13b003d034020bbaaaa942808"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a850c43a13b003d034020bbaaaa942808">&#9670;&nbsp;</a></span>setStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Grpc\ServerContext::setStatus </td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname"><em>$status</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aaecd6027bc712b9a6c6b59d433b2894b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaecd6027bc712b9a6c6b59d433b2894b">&#9670;&nbsp;</a></span>status()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Grpc\ServerContext::status </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/php/lib/Grpc/<a class="el" href="_server_context_8php.html">ServerContext.php</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Sep 6 2023 16:09:47 for GRPC PHP by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>