ngrok

Documentation

Index

• type Agent
• type AgentClient
  • func (c *AgentClient) Find(ctx context.Context, tunnelName string) (*Tunnel, error)
  • func (c *AgentClient) Start(ctx context.Context, tunnelName string, config TunnelConfig) (*Tunnel, error)
  • func (c *AgentClient) Stop(ctx context.Context, tunnelName string) error
• type Tunnel
• type TunnelConfig

Types

type Agent

type Agent interface {
	Find(ctx context.Context, tunnelName string) (*Tunnel, error)
	Start(ctx context.Context, tunnelName string, config TunnelConfig) (*Tunnel, error)
	Stop(ctx context.Context, tunnelName string) error
}

var DefaultAgent Agent = &AgentClient{Client: &http.Client{}}

type AgentClient

type AgentClient struct {
	*http.Client
}

func (*AgentClient) Find

func (c *AgentClient) Find(ctx context.Context, tunnelName string) (*Tunnel, error)

func (*AgentClient) Start

func (c *AgentClient) Start(ctx context.Context, tunnelName string, config TunnelConfig) (*Tunnel, error)

func (*AgentClient) Stop

func (c *AgentClient) Stop(ctx context.Context, tunnelName string) error

type Tunnel

type Tunnel struct {
	Name      string       `json:"name"`
	Addr      string       `json:"addr,omitempty"`
	URI       string       `json:"uri,omitempty"`
	PublicURL string       `json:"public_url,omitempty"`
	Proto     string       `json:"proto"`
	Config    TunnelConfig `json:"config,omitempty"`
}

type TunnelConfig

type TunnelConfig struct {
	Addr       string `json:"addr,omitempty"`
	Proto      string `json:"proto,omitempty"`
	RemoteAddr string `json:"remote_addr,omitempty"`
}