@jp-web/ts-sdk

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>StompSocketConfig | webrtc-guest-sdk</title> <meta name="description" content="Documentation for webrtc-guest-sdk"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">webrtc-guest-sdk</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../index.html">Globals</a> </li> <li> <a href="../modules/_interface_stomp_socket_stompsocketconfig_.html">"interface/stomp-socket/StompSocketConfig"</a> </li> <li> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html">StompSocketConfig</a> </li> </ul> <h1>Interface StompSocketConfig</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p><a href="_interface_stomp_socket_stompsocket_.stompsocket.html">StompSocket</a>参数定义</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">StompSocketConfig</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section tsd-is-external"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#connecturl" class="tsd-kind-icon">connect<wbr>Url</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#enableack" class="tsd-kind-icon">enableACK</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#headers" class="tsd-kind-icon">headers</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#heartbeaturl" class="tsd-kind-icon">heartbeat<wbr>Url</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#interval" class="tsd-kind-icon">interval</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#maxreconnectcount" class="tsd-kind-icon">max<wbr>Reconnect<wbr>Count</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#receiveurl" class="tsd-kind-icon">receive<wbr>Url</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#reconnectinterval" class="tsd-kind-icon">reconnect<wbr>Interval</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#sendurl" class="tsd-kind-icon">send<wbr>Url</a></li> <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#timeout" class="tsd-kind-icon">timeout</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-external"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="connecturl" class="tsd-anchor"></a> <h3>connect<wbr>Url</h3> <div class="tsd-signature tsd-kind-icon">connect<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>WebSocket连接地址</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="enableack" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> enableACK</h3> <div class="tsd-signature tsd-kind-icon">enableACK<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>是否开启消息ack机制, 如果为 <code>true</code> 发送的信令消息除非指定为 <code>false</code> 否则默认都会需要ack响应</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="headers" class="tsd-anchor"></a> <h3>headers</h3> <div class="tsd-signature tsd-kind-icon">headers<span class="tsd-signature-symbol">:</span> <a href="../modules/_interface_stomp_socket_stompsocketconfig_.html#socketheaders" class="tsd-signature-type">SocketHeaders</a></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>使用STOMP协议进行连接时所需要的验证信息</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="heartbeaturl" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> heartbeat<wbr>Url</h3> <div class="tsd-signature tsd-kind-icon">heartbeat<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>心跳destination</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="interval" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> interval</h3> <div class="tsd-signature tsd-kind-icon">interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>心跳间隔, 单位: ms</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="maxreconnectcount" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Reconnect<wbr>Count</h3> <div class="tsd-signature tsd-kind-icon">max<wbr>Reconnect<wbr>Count<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>最大重连次数</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="receiveurl" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> receive<wbr>Url</h3> <div class="tsd-signature tsd-kind-icon">receive<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>接收消息的destination</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="reconnectinterval" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> reconnect<wbr>Interval</h3> <div class="tsd-signature tsd-kind-icon">reconnect<wbr>Interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>重连间隔, 单位: ms</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="sendurl" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> send<wbr>Url</h3> <div class="tsd-signature tsd-kind-icon">send<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>默认发送消息的destination, 可用{@link Socket.sendTo}指定destination</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a name="timeout" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagOptional">Optional</span> timeout</h3> <div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>心跳超时时间, 单位: ms</p> </div> </div> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../index.html"><em>Globals</em></a> </li> <li class="current tsd-kind-module tsd-is-external"> <a href="../modules/_interface_stomp_socket_stompsocketconfig_.html">"interface/stomp-<wbr>socket/<wbr>Stomp<wbr>Socket<wbr>Config"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-interface tsd-parent-kind-module tsd-is-external"> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html" class="tsd-kind-icon">Stomp<wbr>Socket<wbr>Config</a> <ul> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#connecturl" class="tsd-kind-icon">connect<wbr>Url</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#enableack" class="tsd-kind-icon">enableACK</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#headers" class="tsd-kind-icon">headers</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#heartbeaturl" class="tsd-kind-icon">heartbeat<wbr>Url</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#interval" class="tsd-kind-icon">interval</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#maxreconnectcount" class="tsd-kind-icon">max<wbr>Reconnect<wbr>Count</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#receiveurl" class="tsd-kind-icon">receive<wbr>Url</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#reconnectinterval" class="tsd-kind-icon">reconnect<wbr>Interval</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#sendurl" class="tsd-kind-icon">send<wbr>Url</a> </li> <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external"> <a href="_interface_stomp_socket_stompsocketconfig_.stompsocketconfig.html#timeout" class="tsd-kind-icon">timeout</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-external"> <a href="../modules/_interface_stomp_socket_stompsocketconfig_.html#socketheaders" class="tsd-kind-icon">Socket<wbr>Headers</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>