Marionette.Drivers.Tcp Class
NodeJS only tcp socket driver for marionette. See Marionette.Drivers.MozTcp for the gecko/xpcom vesion of this driver.
Constructor
Marionette.Drivers.Tcp
-
options
Parameters:
-
optionsOptionsconnection options.
-
[host="localhost"]String optionalhost.
-
[port="2828"]Numeric optionalport.
-
Item Index
Methods
_nextCommand
()
private
Checks queue if not waiting for a response Sends command to websocket server
_onDeviceResponse
-
data
Handles responses from devices. Will only respond to the event if the connectionId is equal to the event id and the client is ready.
Parameters:
-
dataObjectresponse from server.
close
()
Destroys connection to server
Will immediately close connection to server closing any pending responses.
connect
-
callback
Connects to a remote server. Requires a _connect function to be defined.
MyClass.prototype._connect = function _connect(){
//open a socket to marrionete accept response
//you *must* call _onDeviceResponse with the first
//response from marionette it looks like this:
//{ from: 'root', applicationType: 'gecko', traits: [] }
this.connectionId = result.id;
}Parameters:
-
callbackFunctionexecutes after successfully connecting to the server.
send
-
command -
callback
Sends remote command to server. Each command will be queued while waiting for any pending commands. This ensures order of response is correct.
setScriptTiemout
-
the
We just set the script timeout. If you need to do something in the driver.
Parameters:
-
theIntegertimeout value.
waitForSocket
-
[options] -
[callback]
Utility to wait for the marionette socket to be ready.