serverconfig.html 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. <!doctype html>
  2. <html class="default no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  6. <title>ServerConfig | @urtc/sdk-web</title>
  7. <meta name="description" content="Documentation for @urtc/sdk-web">
  8. <meta name="viewport" content="width=device-width, initial-scale=1">
  9. <link rel="stylesheet" href="../assets/css/main.css">
  10. </head>
  11. <body>
  12. <header>
  13. <div class="tsd-page-toolbar">
  14. <div class="container">
  15. <div class="table-wrap">
  16. <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
  17. <div class="field">
  18. <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
  19. <input id="tsd-search-field" type="text" />
  20. </div>
  21. <ul class="results">
  22. <li class="state loading">Preparing search index...</li>
  23. <li class="state failure">The search index is not available</li>
  24. </ul>
  25. <a href="../index.html" class="title">@urtc/sdk-web</a>
  26. </div>
  27. <div class="table-cell" id="tsd-widgets">
  28. <div id="tsd-filter">
  29. <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
  30. <div class="tsd-filter-group">
  31. <div class="tsd-select" id="tsd-filter-visibility">
  32. <span class="tsd-select-label">All</span>
  33. <ul class="tsd-select-list">
  34. <li data-value="public">Public</li>
  35. <li data-value="protected">Public/Protected</li>
  36. <li data-value="private" class="selected">All</li>
  37. </ul>
  38. </div>
  39. <input type="checkbox" id="tsd-filter-inherited" checked />
  40. <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
  41. <input type="checkbox" id="tsd-filter-externals" checked />
  42. <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
  43. </div>
  44. </div>
  45. <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
  46. </div>
  47. </div>
  48. </div>
  49. </div>
  50. <div class="tsd-page-title">
  51. <div class="container">
  52. <ul class="tsd-breadcrumb">
  53. <li>
  54. <a href="../index.html">Globals</a>
  55. </li>
  56. <li>
  57. <a href="serverconfig.html">ServerConfig</a>
  58. </li>
  59. </ul>
  60. <h1>Interface ServerConfig</h1>
  61. </div>
  62. </div>
  63. </header>
  64. <div class="container container-main">
  65. <div class="row">
  66. <div class="col-8 col-content">
  67. <section class="tsd-panel tsd-comment">
  68. <div class="tsd-comment tsd-typography">
  69. <div class="lead">
  70. <p>服务器配置,可设置置网关(gateway)、信令(signal)、日志(log)服务器地址</p>
  71. <blockquote>
  72. <p>注:</p>
  73. <ol>
  74. <li>gateway 和 signal 须二选一进行设置</li>
  75. <li>没有日志服务器时,log 可不设</li>
  76. </ol>
  77. </blockquote>
  78. </div>
  79. </div>
  80. </section>
  81. <section class="tsd-panel tsd-hierarchy">
  82. <h3>Hierarchy</h3>
  83. <ul class="tsd-hierarchy">
  84. <li>
  85. <span class="target">ServerConfig</span>
  86. </li>
  87. </ul>
  88. </section>
  89. <section class="tsd-panel-group tsd-index-group">
  90. <h2>Index</h2>
  91. <section class="tsd-panel tsd-index-panel">
  92. <div class="tsd-index-content">
  93. <section class="tsd-index-section tsd-is-external">
  94. <h3>Properties</h3>
  95. <ul class="tsd-index-list">
  96. <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="serverconfig.html#gateway" class="tsd-kind-icon">gateway</a></li>
  97. <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="serverconfig.html#log" class="tsd-kind-icon">log</a></li>
  98. <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="serverconfig.html#signal" class="tsd-kind-icon">signal</a></li>
  99. </ul>
  100. </section>
  101. </div>
  102. </section>
  103. </section>
  104. <section class="tsd-panel-group tsd-member-group tsd-is-external">
  105. <h2>Properties</h2>
  106. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
  107. <a name="gateway" class="tsd-anchor"></a>
  108. <h3><span class="tsd-flag ts-flagOptional">Optional</span> gateway</h3>
  109. <div class="tsd-signature tsd-kind-icon">gateway<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
  110. <aside class="tsd-sources">
  111. </aside>
  112. <div class="tsd-comment tsd-typography">
  113. <div class="lead">
  114. <p>网关地址,如 &#39;<a href="https://urtc.com.cn&#39;">https://urtc.com.cn&#39;</a></p>
  115. </div>
  116. </div>
  117. </section>
  118. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
  119. <a name="log" class="tsd-anchor"></a>
  120. <h3><span class="tsd-flag ts-flagOptional">Optional</span> log</h3>
  121. <div class="tsd-signature tsd-kind-icon">log<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
  122. <aside class="tsd-sources">
  123. </aside>
  124. <div class="tsd-comment tsd-typography">
  125. <div class="lead">
  126. <p>日志服务器地址,如 &#39;<a href="https://log.urtc.com.cn&#39;">https://log.urtc.com.cn&#39;</a></p>
  127. </div>
  128. </div>
  129. </section>
  130. <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
  131. <a name="signal" class="tsd-anchor"></a>
  132. <h3><span class="tsd-flag ts-flagOptional">Optional</span> signal</h3>
  133. <div class="tsd-signature tsd-kind-icon">signal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
  134. <aside class="tsd-sources">
  135. </aside>
  136. <div class="tsd-comment tsd-typography">
  137. <div class="lead">
  138. <p>信令服务器地址,如 &#39;wss://urtc.com.cn:5005&#39;</p>
  139. </div>
  140. </div>
  141. </section>
  142. </section>
  143. </div>
  144. <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
  145. <nav class="tsd-navigation primary">
  146. <ul>
  147. <li class="globals ">
  148. <a href="../index.html"><em>Globals</em></a>
  149. </li>
  150. </ul>
  151. </nav>
  152. <nav class="tsd-navigation secondary menu-sticky">
  153. <ul class="before-current">
  154. </ul>
  155. <ul class="current">
  156. <li class="current tsd-kind-interface tsd-is-external">
  157. <a href="serverconfig.html" class="tsd-kind-icon">Server<wbr>Config</a>
  158. <ul>
  159. <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
  160. <a href="serverconfig.html#gateway" class="tsd-kind-icon">gateway</a>
  161. </li>
  162. <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
  163. <a href="serverconfig.html#log" class="tsd-kind-icon">log</a>
  164. </li>
  165. <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
  166. <a href="serverconfig.html#signal" class="tsd-kind-icon">signal</a>
  167. </li>
  168. </ul>
  169. </li>
  170. </ul>
  171. <ul class="after-current">
  172. </ul>
  173. </nav>
  174. </div>
  175. </div>
  176. </div>
  177. <footer class="with-border-bottom">
  178. <div class="container">
  179. <h2>Legend</h2>
  180. <div class="tsd-legend-group">
  181. </div>
  182. </div>
  183. </footer>
  184. <div class="container tsd-generator">
  185. <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
  186. </div>
  187. <div class="overlay"></div>
  188. <script src="../assets/js/main.js"></script>
  189. </body>
  190. </html>