<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yar-server.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'yar-server.construct.php',
    1 => 'Yar_Server::__construct',
    2 => '创建一个 RPC 服务端',
  ),
  'up' => 
  array (
    0 => 'class.yar-server.php',
    1 => 'Yar_Server',
  ),
  'prev' => 
  array (
    0 => 'class.yar-server.php',
    1 => 'Yar_Server',
  ),
  'next' => 
  array (
    0 => 'yar-server.handle.php',
    1 => 'Yar_Server::handle',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/yar/yar_server/construct.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yar-server.construct" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Yar_Server::__construct</h1>
  <p class="verinfo">(PECL yar &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">Yar_Server::__construct</span> &mdash; <span class="dc-title">创建一个 RPC 服务端</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yar-server.construct-description">
  <h3 class="title">说明</h3>
  <div class="constructorsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>Yar_Server::__construct</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.object.php" class="type object">object</a></span> <code class="parameter">$executor</code></span>)</div>

  <p class="simpara">
   创建一个 Yar HTTP RPC 服务器。
   <code class="parameter">executor</code> 的所有公开方法都会被注册为 RPC 服务。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yar-server.construct-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt><code class="parameter">executor</code></dt>
    <dd>
     <p class="simpara">
      任意一个对象，其公开方法将被作为 RPC 服务对外暴露。
      受保护和私有方法，以及方法名以下划线开头的方法，不会被暴露。
     </p>
     <p class="simpara">
      执行对象还可以定义两个受保护的魔法方法，
      它们会被 <span class="methodname"><a href="yar-server.handle.php" class="methodname">Yar_Server::handle()</a></span>
      识别，且永远不会作为 RPC 端点对外暴露：
     </p>
     <ul class="itemizedlist">
      <li class="listitem">
       <p class="simpara">
        <code class="literal">protected function __info(string $markup):
        string</code> — 自 Yar 2.3.0 起。在请求服务信息页面时被调用；
        它接收 Yar 原本要渲染的页面标记（markup），
        如果返回一个 <span class="type"><a href="language.types.string.php" class="type string">string</a></span>，该字符串会被发送给客户端，
        替代默认的页面。参见
        <span class="methodname"><a href="yar-server.handle.php" class="methodname">Yar_Server::handle()</a></span>。
       </p>
      </li>
      <li class="listitem">
       <p class="simpara">
        <code class="literal">protected function __auth(string $provider, string
        $token): bool</code> — 自 Yar 2.3.0 起。在每个请求处理的最开始被调用，
        请求头中的 <code class="literal">provider</code> 和
        <code class="literal">token</code> 字段会作为参数传入，
        这两个字段由客户端通过
        <strong><code><a href="yar.constants.php#constant.yar-opt-provider">YAR_OPT_PROVIDER</a></code></strong> 和
        <strong><code><a href="yar.constants.php#constant.yar-opt-token">YAR_OPT_TOKEN</a></code></strong> 选项设置。
        严格返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> 表示拒绝该请求；任何其他返回值都会让请求继续。
        参见 <span class="methodname"><a href="yar-server.handle.php" class="methodname">Yar_Server::handle()</a></span>。
       </p>
      </li>
     </ul>
     <p class="simpara">
      这两个方法只有在声明为 <code class="literal">protected</code> 时才生效；
      同名的公开或私有方法会被忽略。
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-yar-server.construct-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="simpara">
   一个 <span class="classname"><a href="class.yar-server.php" class="classname">Yar_Server</a></span> 实例。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-yar-server.construct-examples">
  <h3 class="title">示例</h3>
  <div class="example" id="example-1">
   <p><strong>示例 #1 <span class="methodname"><strong>Yar_Server::__construct()</strong></span> 示例</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
</span><span style="color: #007700">class </span><span style="color: #0000BB">API </span><span style="color: #007700">{
    </span><span style="color: #FF8000">/**
     * The doc block is shown on the service info page.
     * @param string $parameter
     * @return string
     */
    </span><span style="color: #007700">public function </span><span style="color: #0000BB">some_method</span><span style="color: #007700">(</span><span style="color: #0000BB">$parameter</span><span style="color: #007700">, </span><span style="color: #0000BB">$option </span><span style="color: #007700">= </span><span style="color: #DD0000">"foo"</span><span style="color: #007700">) {
         return </span><span style="color: #DD0000">"some_method"</span><span style="color: #007700">;
    }

    protected function </span><span style="color: #0000BB">client_can_not_see</span><span style="color: #007700">() {
    }
}

</span><span style="color: #0000BB">$service </span><span style="color: #007700">= new </span><span style="color: #0000BB">Yar_Server</span><span style="color: #007700">(new </span><span style="color: #0000BB">API</span><span style="color: #007700">());
</span><span style="color: #0000BB">$service</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">handle</span><span style="color: #007700">();
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yar-server.construct-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="yar-server.handle.php" class="methodname" rel="rdfs-seeAlso">Yar_Server::handle()</a> - 启动 RPC 服务端</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>