Class SocketTransport
Defined in: SocketTransport.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Firefox Socket Transport for remote debug protocol.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
SocketTransport.addListener(listener)
Adds listener to be called when the transport receives requests.
|
| <static> |
SocketTransport.close()
close a previously opened connection.
|
| <static> |
SocketTransport.listen(host, port)
Listen for connections on localhost to the specified port.
|
| <static> |
SocketTransport.open(host, port)
Open a connection to the specified host/port.
|
| <static> |
SocketTransport.sendEvent(event, data)
Send an event packet.
|
| <static> |
SocketTransport.sendResponse(command, requestSeq, body, running, success)
Builds and sends a response packet.
|
Class Detail
SocketTransport()
Firefox Socket Transport for remote debug protocol.
Opens a socket connection to a remote host and handles handshaking and
sending/receiving packets.
Method Detail
<static>
SocketTransport.addListener(listener)
Adds listener to be called when the transport receives requests.
The transport will pass a RequestPacket @see Packet.js
as an argument to the listener's "handleRequest" method.
- Parameters:
- listener
- An object which contains a method named "handleRequest".
<static>
SocketTransport.close()
close a previously opened connection.
<static>
SocketTransport.listen(host, port)
Listen for connections on localhost to the specified port.
- Parameters:
- {String} host
- the hostname.
- {Number} port
- the port.
<static>
SocketTransport.open(host, port)
Open a connection to the specified host/port.
- Parameters:
- {String} host
- the hostname.
- {Number} port
- the port.
<static>
SocketTransport.sendEvent(event, data)
Send an event packet. @see also Packet.js
- Parameters:
- event
- Event name
- data
- optional JSON object containing additional data about the event.
<static>
SocketTransport.sendResponse(command, requestSeq, body, running, success)
Builds and sends a response packet. @see also Packet.js
- Parameters:
- command
- The name of the command for the response.
- requestSeq
- Sequence number of the request that initiated the response.
- body
- JSON body of the response
- running
- boolean indicates if execution is continuing.
- success
- boolean indicates whether the command was successful.