Chrome Remote Interface v0.2.0 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

Link to this section Functions

Link to this function call(pid, method, params, timeout) View Source

Executes a raw JSON RPC command through Websockets.

Link to this function 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.

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function 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.

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

args 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 handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

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 :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 (re)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 calling Supervisor.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.

Connect to a Page’s ‘webSocketDebuggerUrl’.

Stop the websocket connection to the page.

Link to this function subscribe(pid, event, subscriber_pid \\ self()) View Source
subscribe(pid, String.t, pid) :: any

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}}}
Link to this function unsubscribe(pid, event, subscriber_pid \\ self()) View Source
unsubscribe(pid, String.t, pid) :: any

Unsubscribes from an event.

Link to this function unsubscribe_all(pid, subscriber_pid \\ self()) View Source

Unsubcribes to all events.