Chrome Remote Interface v0.4.1 ChromeRemoteInterface.PageSession View Source
This module is responsible for all things connected to a Page.
- Spawning a process that manages the websocket connection
- Handling request/response for RPC calls by maintaining unique message IDs
- Forwarding Domain events to subscribers.
Link to this section Summary
Functions
Executes a raw JSON RPC command through Websockets.
Executes a raw JSON RPC command through Websockets, but sends the response as a message to the requesting process.
Returns a specification to start this module under a supervisor.
Executes an RPC command with the given options.
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
Connect to a Page's 'webSocketDebuggerUrl'.
Stop the websocket connection to the page.
Subscribe to an event.
Unsubscribes from an event.
Unsubcribes to all events.
Link to this section Functions
call(pid, method, params, timeout) View Source
Executes a raw JSON RPC command through Websockets.
cast(pid, method, params, from \\ self()) View Source
Executes a raw JSON RPC command through Websockets, but sends the response as a message to the requesting process.
child_spec(init_arg) View Source
Returns a specification to start this module under a supervisor.
See Supervisor
.
execute_command(pid, method, params, opts) View Source
Executes an RPC command with the given options.
Options:
:async
-
If a boolean, sends the response as a message to the current process.
Else, if provided with a PID, it will send the response to that process instead.
:timeout
-
This sets the timeout for the blocking call, defaults to 5 seconds.
init(url) View Source
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
,
except that it also sets a timeout. See the "Timeouts" section
in the module documentation for more information.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
start_link(url) View Source
Connect to a Page's 'webSocketDebuggerUrl'.
stop(page_pid) View Source
Stop the websocket connection to the page.
subscribe(pid, event, subscriber_pid \\ self()) View Source
Subscribe to an event.
Events that get fired will be returned to the subscribed process under the following format:
{:chrome_remote_interface, event_name, response}
Please note that you must also enable events for that domain!
Example:
iex> ChromeRemoteInterface.RPC.Page.enable(page_pid)
iex> ChromeRemoteInterface.PageSession.subscribe(page_pid, "Page.loadEventFired")
iex> ChromeRemoteInterface.RPC.Page.navigate(page_pid, %{url: "https://google.com"})
iex> flush()
{:chrome_remote_interface, "Page.loadEventFirst", %{"method" => "Page.loadEventFired",
"params" => %{"timestamp" => 1012329.888558}}}
unsubscribe(pid, event, subscriber_pid \\ self()) View Source
Unsubscribes from an event.
unsubscribe_all(pid, subscriber_pid \\ self()) View Source
Unsubcribes to all events.