chroxy

v0.3.0

chroxy

chroxy v0.3.0 Chroxy.ChromeProxy

Process which establishes a single proxied websocket connection to an underlying chrome browser page remote debugging websocket.

Upon initialisation, the chrome proxy signal the Chroxy.ProxyListener to accept a TCP connection. The Chroxy.ProxyListener will initialise a Chroxy.ProxyServer to manage the connection between the upstream client and the downstream chrome remote debugging websocket.

When either the upstream or downstream connections close, the down/2 behaviours Chroxy.ProxyServer.Hook callback is invoked, allowing the Chroxy.ChromeProxy to close the chrome page.

Link to this section Summary

Functions

chrome_connection(ref)

Starts a chrome page, and returns a websocket connection routed via the underlying proxy

down(ref, proxy_state)

Chroxy.ProxyServer Callback Hook Called when upstream or downstream connections are closed. Will close the chrome page and shutdown this process

init(args)

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

start_link(args)

Spawns Chroxy.ChromeProxy process

Link to this section Functions

Link to this function chrome_connection(ref)

Starts a chrome page, and returns a websocket connection routed via the underlying proxy.

Link to this function down(ref, proxy_state)

Chroxy.ProxyServer Callback Hook Called when upstream or downstream connections are closed. Will close the chrome page and shutdown this process.

Link to this function init(args)

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.

Link to this function start_link(args)

Spawns Chroxy.ChromeProxy process.

Keyword args: