source-docs/InspectorBackendClass.Connection.html at gh-pages · iambite/source-docs · GitHub

1
2
<!DOCTYPE html><meta charset="UTF-8"><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no"><meta http-equiv="Content-Language" content="en"><meta http-equiv="X-UA-Compatible" content="IE=edge"><link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet"><title>Connection</title><link href="dossier.css" rel="stylesheet" type="text/css"><header><button class="dossier-menu"><i class="material-icons">menu</i></button><form><input type="search" placeholder="Search" tabindex="1"><i class="material-icons">search</i></form></header><div class="content"><main><article><section class="intro"><div class="codelink"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l207">View Source</a></div><h1 class="title"><div>class Connection</div></h1><pre class="inheritance"><a href="WebInspector.Object.html">WebInspector.Object</a>
  &#x2514; InspectorBackendClass.Connection</pre><dl><dt class="spec">All implemented interfaces<dd><code><a href="WebInspector.EventTarget.html">WebInspector.EventTarget</a></code></dl><p>No description available.</p><h3 class="name"><div>new Connection()</div></h3><dt class="spec">Parameters</dt><dd><dl><dd><p>None.</p></dl></dd></section><section class="instance-methods"><h2>Instance Methods</h2><section class="property" id="_dispatchConnectionErrorResponse"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l448" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_dispatchConnectionErrorResponse(<wbr>domain,<wbr> methodName,<wbr> callback)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">domain<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dt class="named">methodName<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dt class="named">callback<code>function(*): ?</code></dl></dd></dl></section><section class="property" id="_dumpProtocolMessage"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l417" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_dumpProtocolMessage(<wbr>message)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">message<code>?</code></dl></dd></dl></section><section class="property" id="_executeAfterPendingDispatches"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l407" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_executeAfterPendingDispatches()</div></h3><p>No information.</p></section><section class="property" id="_initialize"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l227" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_initialize(<wbr>agentPrototypes,<wbr> dispatcherPrototypes)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">agentPrototypes<code>!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a href="InspectorBackendClass.AgentPrototype.html">InspectorBackendClass.AgentPrototype</a>&gt;</code><dt class="named">dispatcherPrototypes<code>!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a href="InspectorBackendClass.DispatcherPrototype.html">InspectorBackendClass.DispatcherPrototype</a>&gt;</code></dl></dd></dl></section><section class="property" id="_runPendingCallbacks"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l433" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_runPendingCallbacks()</div></h3><p>No information.</p></section><section class="property" id="_wrap"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l299" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_wrap(<wbr>callback,<wbr> method,<wbr> domain)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">callback<code>?function(*): ?</code><dt class="named">method<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dt class="named">domain<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dl></dd><dt class="spec">Returns</dt><dd><dl><dt><code>function(*): ?</code></dl></dd></dl></section><section class="property" id="_wrapCallbackAndSendMessageObject"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l269" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_wrapCallbackAndSendMessageObject(<wbr>domain,<wbr> method,<wbr> params,<wbr> callback)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">domain<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dt class="named">method<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dt class="named">params<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code><dt class="named">callback<code>?function(*): ?</code></dl></dd></dl></section><section class="property" id="addEventListener"><div class="code-link"><a href="source/front_end/common/Object.js.src.html#l41" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>addEventListener(<wbr>eventType,<wbr> listener,<wbr> thisObject)</div></h3><dl><dt class="spec">Defined by</dt><dd><a href="WebInspector.Object.html#addEventListener">WebInspector.Object</a></dd><dt class="spec">Specified by</dt><dd><a href="WebInspector.EventTarget.html#addEventListener">WebInspector.EventTarget</a></dd><dt class="spec">Parameters</dt><dd><dl><dt class="named">eventType<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dt class="named">listener<code>function(<a href="WebInspector.Event.html">WebInspector.Event</a>): ?</code><dt class="named">thisObject<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>=</code></dl></dd><dt class="spec">Returns</dt><dd><dl><dt><code><a href="WebInspector.EventTarget.EventDescriptor.html">WebInspector.EventTarget.EventDescriptor</a></code></dl></dd></dl></section><section class="property" id="agent"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l250" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>agent(<wbr>domain)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">domain<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dl></dd><dt class="spec">Returns</dt><dd><dl><dt><code><a href="InspectorBackendClass.AgentPrototype.html">InspectorBackendClass.AgentPrototype</a></code></dl></dd></dl></section><section class="property" id="agentsMap"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l258" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>agentsMap()</div></h3><dl><dt class="spec">Returns</dt><dd><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>, <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>&gt;</code></dl></dd></dl></section><section class="property" id="connectionClosed"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l426" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div class="tags"><span class="protected"></span></div><div>connectionClosed(<wbr>reason)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">reason<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dl></dd></dl></section><section class="property" id="deprecatedRunAfterPendingDispatches"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l390" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>deprecatedRunAfterPendingDispatches(<wbr>script)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">script<code>function(): ?=</code></dl></dd></dl></section><section class="property" id="dispatch"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l334" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>dispatch(<wbr>message)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">message<code>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>)</code></dl></dd></dl></section><section class="property" id="dispatchEventToListeners"><div class="code-link"><a href="source/front_end/common/Object.js.src.html#l102" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>dispatchEventToListeners(<wbr>eventType,<wbr> eventData)</div></h3><dl><dt class="spec">Defined by</dt><dd><a href="WebInspector.Object.html#dispatchEventToListeners">WebInspector.Object</a></dd><dt class="spec">Specified by</dt><dd><a href="WebInspector.EventTarget.html#dispatchEventToListeners">WebInspector.EventTarget</a></dd><dt class="spec">Parameters</dt><dd><dl><dt class="named">eventType<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dt class="named">eventData<code>*=</code></dl></dd><dt class="spec">Returns</dt><dd><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dl></dd></dl></section><section class="property" id="hasEventListeners"><div class="code-link"><a href="source/front_end/common/Object.js.src.html#l89" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>hasEventListeners(<wbr>eventType)</div></h3><dl><dt class="spec">Defined by</dt><dd><a href="WebInspector.Object.html#hasEventListeners">WebInspector.Object</a></dd><dt class="spec">Specified by</dt><dd><a href="WebInspector.EventTarget.html#hasEventListeners">WebInspector.EventTarget</a></dd><dt class="spec">Parameters</dt><dd><dl><dt class="named">eventType<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code></dl></dd><dt class="spec">Returns</dt><dd><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dl></dd></dl></section><section class="property" id="isClosed"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l458" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>isClosed()</div></h3><dl><dt class="spec">Returns</dt><dd><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></code></dl></dd></dl></section><section class="property" id="nextMessageId"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l241" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>nextMessageId()</div></h3><dl><dt class="spec">Returns</dt><dd><dl><dt><code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></code></dl></dd></dl></section><section class="property" id="registerDispatcher"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l379" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>registerDispatcher(<wbr>domain,<wbr> dispatcher)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">domain<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dt class="named">dispatcher<code>!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code></dl></dd></dl></section><section class="property" id="removeAllListeners"><div class="code-link"><a href="source/front_end/common/Object.js.src.html#l79" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>removeAllListeners()</div></h3><dl><dt class="spec">Defined by</dt><dd><a href="WebInspector.Object.html#removeAllListeners">WebInspector.Object</a></dd><dt class="spec">Specified by</dt><dd><a href="WebInspector.EventTarget.html#removeAllListeners">WebInspector.EventTarget</a></dd></dl></section><section class="property" id="removeEventListener"><div class="code-link"><a href="source/front_end/common/Object.js.src.html#l60" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>removeEventListener(<wbr>eventType,<wbr> listener,<wbr> thisObject)</div></h3><dl><dt class="spec">Defined by</dt><dd><a href="WebInspector.Object.html#removeEventListener">WebInspector.Object</a></dd><dt class="spec">Specified by</dt><dd><a href="WebInspector.EventTarget.html#removeEventListener">WebInspector.EventTarget</a></dd><dt class="spec">Parameters</dt><dd><dl><dt class="named">eventType<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dt class="named">listener<code>function(<a href="WebInspector.Event.html">WebInspector.Event</a>): ?</code><dt class="named">thisObject<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>=</code></dl></dd></dl></section><section class="property" id="sendMessage"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l315" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>sendMessage(<wbr>messageObject)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">messageObject<code>!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code></dl></dd></dl></section><section class="property" id="sendRawMessageForTesting"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l325" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>sendRawMessageForTesting(<wbr>method,<wbr> params,<wbr> callback)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">method<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a></code><dt class="named">params<code><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></code><dt class="named">callback<code>?function(...*): ?</code></dl></dd></dl></section><section class="property" id="suppressErrorsForDomains"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l466" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>suppressErrorsForDomains(<wbr>domains)</div></h3><dl><dt class="spec">Parameters</dt><dd><dl><dt class="named">domains<code>!<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&lt;<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>&gt;</code></dl></dd></dl></section></section><section class="instance-properties"><h2>Instance Properties</h2><section class="property" id="_agents"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l211" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_agents</div></h3><dl><dt class="spec">Type<dd><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></dd></dl></section><section class="property" id="_callbacks"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l440" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_callbacks</div></h3><dl><dt class="spec">Type<dd>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>|<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>)</dd></dl></section><section class="property" id="_dispatchers"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l212" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_dispatchers</div></h3><dl><dt class="spec">Type<dd><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a></dd></dl></section><section class="property" id="_isConnected"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l428" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_isConnected</div></h3><dl><dt class="spec">Type<dd><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></dd></dl></section><section class="property" id="_lastMessageId"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l209" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_lastMessageId</div></h3><dl><dt class="spec">Type<dd><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></dd></dl></section><section class="property" id="_pendingResponsesCount"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l210" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>_pendingResponsesCount</div></h3><dl><dt class="spec">Type<dd><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></dd></dl></section></section><section class="static-properties"><h2>Static Properties</h2><section class="property" id="Connection.Events"><div class="code-link"><a href="source/front_end/sdk/InspectorBackend.js.src.html#l218" title="View source"><i class="material-icons">code</i></a></div><h3 class="name"><div>Connection.Events</div></h3><dl><dt class="spec">Type<dd>{Disconnected: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>}</dd></dl></section></section></article></main><footer><div><a href="https://github.com/jleyba/js-dossier">Generated by dossier</a></div></footer></div><nav class="dossier-nav"><section><a class="title" href="index.html" tabindex="2">Overview</a></section><section class="types"><div class="toggle"><div class="title"><span class="item" tabindex="2">Types</span><i class="material-icons">expand_more</i></div></div></section></nav><script src="types.js"></script><script src="dossier.js"></script>