1 2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3 <html><head><title>Python: module telemetry.internal.backends.chrome_inspector.inspector_websocket</title> 4 <meta charset="utf-8"> 5 </head><body bgcolor="#f0f0f8"> 6 7 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> 8 <tr bgcolor="#7799ee"> 9 <td valign=bottom> <br> 10 <font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.backends.html"><font color="#ffffff">backends</font></a>.<a href="telemetry.internal.backends.chrome_inspector.html"><font color="#ffffff">chrome_inspector</font></a>.inspector_websocket</strong></big></big></font></td 11 ><td align=right valign=bottom 12 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/backends/chrome_inspector/inspector_websocket.py">telemetry/internal/backends/chrome_inspector/inspector_websocket.py</a></font></td></tr></table> 13 <p><tt># Copyright 2014 The Chromium Authors. All rights reserved.<br> 14 # Use of this source code is governed by a BSD-style license that can be<br> 15 # found in the LICENSE file.</tt></p> 16 <p> 17 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 18 <tr bgcolor="#aa55cc"> 19 <td colspan=3 valign=bottom> <br> 20 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> 21 22 <tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> 23 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="errno.html">errno</a><br> 24 <a href="telemetry.core.exceptions.html">telemetry.core.exceptions</a><br> 25 </td><td width="25%" valign=top><a href="json.html">json</a><br> 26 <a href="logging.html">logging</a><br> 27 </td><td width="25%" valign=top><a href="socket.html">socket</a><br> 28 <a href="time.html">time</a><br> 29 </td><td width="25%" valign=top><a href="telemetry.internal.backends.chrome_inspector.websocket.html">telemetry.internal.backends.chrome_inspector.websocket</a><br> 30 </td></tr></table></td></tr></table><p> 31 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 32 <tr bgcolor="#ee77aa"> 33 <td colspan=3 valign=bottom> <br> 34 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 35 36 <tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 37 <td width="100%"><dl> 38 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> 39 </font></dt><dd> 40 <dl> 41 <dt><font face="helvetica, arial"><a href="telemetry.internal.backends.chrome_inspector.inspector_websocket.html#InspectorWebsocket">InspectorWebsocket</a> 42 </font></dt></dl> 43 </dd> 44 <dt><font face="helvetica, arial"><a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>) 45 </font></dt><dd> 46 <dl> 47 <dt><font face="helvetica, arial"><a href="telemetry.internal.backends.chrome_inspector.inspector_websocket.html#WebSocketDisconnected">WebSocketDisconnected</a> 48 </font></dt></dl> 49 </dd> 50 </dl> 51 <p> 52 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 53 <tr bgcolor="#ffc8d8"> 54 <td colspan=3 valign=bottom> <br> 55 <font color="#000000" face="helvetica, arial"><a name="InspectorWebsocket">class <strong>InspectorWebsocket</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> 56 57 <tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 58 <td width="100%">Methods defined here:<br> 59 <dl><dt><a name="InspectorWebsocket-AsyncRequest"><strong>AsyncRequest</strong></a>(self, req, callback)</dt><dd><tt>Sends an async request and returns immediately.<br> 60 <br> 61 Response will be handled in the |callback| later when DispatchNotifications<br> 62 is invoked.<br> 63 <br> 64 Args:<br> 65 callback: a function that takes inspector's response as the argument.</tt></dd></dl> 66 67 <dl><dt><a name="InspectorWebsocket-Connect"><strong>Connect</strong></a>(self, url, timeout<font color="#909090">=10</font>)</dt><dd><tt>Connects the websocket.<br> 68 <br> 69 Raises:<br> 70 websocket.WebSocketException<br> 71 socket.error</tt></dd></dl> 72 73 <dl><dt><a name="InspectorWebsocket-Disconnect"><strong>Disconnect</strong></a>(self)</dt><dd><tt>Disconnects the inspector websocket.<br> 74 <br> 75 Raises:<br> 76 websocket.WebSocketException<br> 77 socket.error</tt></dd></dl> 78 79 <dl><dt><a name="InspectorWebsocket-DispatchNotifications"><strong>DispatchNotifications</strong></a>(self, timeout<font color="#909090">=10</font>)</dt><dd><tt>Waits for responses from the websocket, dispatching them as necessary.<br> 80 <br> 81 Raises:<br> 82 websocket.WebSocketException: <a href="telemetry.core.exceptions.html#Error">Error</a> from websocket library.<br> 83 socket.error: <a href="telemetry.core.exceptions.html#Error">Error</a> from websocket library.<br> 84 exceptions.<a href="#WebSocketDisconnected">WebSocketDisconnected</a>: The socket was disconnected.</tt></dd></dl> 85 86 <dl><dt><a name="InspectorWebsocket-RegisterDomain"><strong>RegisterDomain</strong></a>(self, domain_name, notification_handler)</dt><dd><tt>Registers a given domain for handling notification methods.<br> 87 <br> 88 For example, given inspector_backend:<br> 89 def OnConsoleNotification(msg):<br> 90 if msg['method'] == 'Console.messageAdded':<br> 91 print msg['params']['message']<br> 92 inspector_backend.<a href="#InspectorWebsocket-RegisterDomain">RegisterDomain</a>('Console', OnConsoleNotification)<br> 93 <br> 94 Args:<br> 95 domain_name: The devtools domain name. E.g., 'Tracing', 'Memory', 'Page'.<br> 96 notification_handler: Handler for devtools notification. Will be<br> 97 called if a devtools notification with matching domain is received<br> 98 via DispatchNotifications. The handler accepts a single paramater:<br> 99 the JSON <a href="__builtin__.html#object">object</a> representing the notification.</tt></dd></dl> 100 101 <dl><dt><a name="InspectorWebsocket-SendAndIgnoreResponse"><strong>SendAndIgnoreResponse</strong></a>(self, req)</dt><dd><tt>Sends a request without waiting for a response.<br> 102 <br> 103 Raises:<br> 104 websocket.WebSocketException: <a href="telemetry.core.exceptions.html#Error">Error</a> from websocket library.<br> 105 socket.error: <a href="telemetry.core.exceptions.html#Error">Error</a> from websocket library.<br> 106 exceptions.<a href="#WebSocketDisconnected">WebSocketDisconnected</a>: The socket was disconnected.</tt></dd></dl> 107 108 <dl><dt><a name="InspectorWebsocket-SyncRequest"><strong>SyncRequest</strong></a>(self, req, timeout<font color="#909090">=10</font>)</dt><dd><tt>Sends a request and waits for a response.<br> 109 <br> 110 Raises:<br> 111 websocket.WebSocketException: <a href="telemetry.core.exceptions.html#Error">Error</a> from websocket library.<br> 112 socket.error: <a href="telemetry.core.exceptions.html#Error">Error</a> from websocket library.<br> 113 exceptions.<a href="#WebSocketDisconnected">WebSocketDisconnected</a>: The socket was disconnected.</tt></dd></dl> 114 115 <dl><dt><a name="InspectorWebsocket-UnregisterDomain"><strong>UnregisterDomain</strong></a>(self, domain_name)</dt><dd><tt>Unregisters a previously registered domain.</tt></dd></dl> 116 117 <dl><dt><a name="InspectorWebsocket-__init__"><strong>__init__</strong></a>(self)</dt><dd><tt>Create a websocket handler for communicating with Inspectors.</tt></dd></dl> 118 119 <hr> 120 Data descriptors defined here:<br> 121 <dl><dt><strong>__dict__</strong></dt> 122 <dd><tt>dictionary for instance variables (if defined)</tt></dd> 123 </dl> 124 <dl><dt><strong>__weakref__</strong></dt> 125 <dd><tt>list of weak references to the object (if defined)</tt></dd> 126 </dl> 127 <hr> 128 Data and other attributes defined here:<br> 129 <dl><dt><strong>METHOD_NOT_FOUND_CODE</strong> = -32601</dl> 130 131 </td></tr></table> <p> 132 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 133 <tr bgcolor="#ffc8d8"> 134 <td colspan=3 valign=bottom> <br> 135 <font color="#000000" face="helvetica, arial"><a name="WebSocketDisconnected">class <strong>WebSocketDisconnected</strong></a>(<a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>)</font></td></tr> 136 137 <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> 138 <td colspan=2><tt>An attempt was made to use a web socket after it had been disconnected.<br> </tt></td></tr> 139 <tr><td> </td> 140 <td width="100%"><dl><dt>Method resolution order:</dt> 141 <dd><a href="telemetry.internal.backends.chrome_inspector.inspector_websocket.html#WebSocketDisconnected">WebSocketDisconnected</a></dd> 142 <dd><a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a></dd> 143 <dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> 144 <dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> 145 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 146 </dl> 147 <hr> 148 Methods inherited from <a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>:<br> 149 <dl><dt><a name="WebSocketDisconnected-AddDebuggingMessage"><strong>AddDebuggingMessage</strong></a>(self, msg)</dt><dd><tt>Adds a message to the description of the exception.<br> 150 <br> 151 Many Telemetry exceptions arise from failures in another application. These<br> 152 failures are difficult to pinpoint. This method allows Telemetry classes to<br> 153 append useful debugging information to the exception. This method also logs<br> 154 information about the location from where it was called.</tt></dd></dl> 155 156 <dl><dt><a name="WebSocketDisconnected-__init__"><strong>__init__</strong></a>(self, msg<font color="#909090">=''</font>)</dt></dl> 157 158 <dl><dt><a name="WebSocketDisconnected-__str__"><strong>__str__</strong></a>(self)</dt></dl> 159 160 <hr> 161 Data descriptors inherited from <a href="telemetry.core.exceptions.html#Error">telemetry.core.exceptions.Error</a>:<br> 162 <dl><dt><strong>__weakref__</strong></dt> 163 <dd><tt>list of weak references to the object (if defined)</tt></dd> 164 </dl> 165 <hr> 166 Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> 167 <dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#WebSocketDisconnected-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> 168 169 <hr> 170 Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 171 <dl><dt><a name="WebSocketDisconnected-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#WebSocketDisconnected-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> 172 173 <dl><dt><a name="WebSocketDisconnected-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#WebSocketDisconnected-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> 174 175 <dl><dt><a name="WebSocketDisconnected-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#WebSocketDisconnected-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> 176 177 <dl><dt><a name="WebSocketDisconnected-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#WebSocketDisconnected-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> 178 <br> 179 Use of negative indices is not supported.</tt></dd></dl> 180 181 <dl><dt><a name="WebSocketDisconnected-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> 182 183 <dl><dt><a name="WebSocketDisconnected-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#WebSocketDisconnected-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> 184 185 <dl><dt><a name="WebSocketDisconnected-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#WebSocketDisconnected-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> 186 187 <dl><dt><a name="WebSocketDisconnected-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> 188 189 <dl><dt><a name="WebSocketDisconnected-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> 190 191 <hr> 192 Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 193 <dl><dt><strong>__dict__</strong></dt> 194 </dl> 195 <dl><dt><strong>args</strong></dt> 196 </dl> 197 <dl><dt><strong>message</strong></dt> 198 </dl> 199 </td></tr></table></td></tr></table> 200 </body></html>
