Sprites.Proxy (Sprites v0.2.0)

Port forwarding and proxying for sprites.

Allows forwarding local ports to remote ports on the sprite.

Summary

Functions

proxy_port(sprite, local_port, remote_port)

Creates a proxy session for a single port.

proxy_ports(sprite, mappings)

Creates proxy sessions for multiple port mappings.

Functions

proxy_port(sprite, local_port, remote_port)

@spec proxy_port(Sprites.Sprite.t(), non_neg_integer(), non_neg_integer()) ::
  {:ok, pid()} | {:error, term()}

Creates a proxy session for a single port.

Examples

{:ok, session} = Sprites.Proxy.proxy_port(sprite, 3000, 3000)

proxy_ports(sprite, mappings)

@spec proxy_ports(Sprites.Sprite.t(), [Sprites.Proxy.PortMapping.t()]) ::
  {:ok, [pid()]} | {:error, term()}

Creates proxy sessions for multiple port mappings.

Examples

mappings = [
  %Sprites.Proxy.PortMapping{local_port: 3000, remote_port: 3000},
  %Sprites.Proxy.PortMapping{local_port: 8080, remote_port: 80}
]
{:ok, sessions} = Sprites.Proxy.proxy_ports(sprite, mappings)