client

Documentation

Index

• type ErrorEvent
• type Event
• type EventHandler
• type EventType
• type RequestEvent
• type Tunnel
• type TunnelManager
  • func NewTunnelManager(cfg *config.ClientConfig, logger *slog.Logger, events EventHandler) TunnelManager

Types

type ErrorEvent

type ErrorEvent struct {
	Error string `json:"error"`
}

type Event

type Event struct {
	Type    EventType   `json:"type"`
	Payload interface{} `json:"payload"`
}

type EventHandler

type EventHandler func(event Event)

type EventType

type EventType string

const (
	EventTypeRequest EventType = "request"
	EventTypeError   EventType = "error"
)

type RequestEvent

type RequestEvent struct {
	TunnelID  string
	Method    string
	Path      string
	Status    int
	Duration  time.Duration
	Error     string
	Timestamp time.Time

	// ConnectionFailed is set to true if the manager lost connection to the server
	ConnectionFailed bool
}

type Tunnel

type Tunnel interface {
	// URL returns the public URL of the tunnel
	URL() string
	// LocalPort returns the local port of the tunnel
	LocalPort() int
	// Close closes the specific tunnel instance
	Close() error
}

type TunnelManager

type TunnelManager interface {
	// NewTunnel creates a new tunnel with an optional ID and returns it
	NewTunnel(localPort int, customId string) (Tunnel, error)
	// Tunnels returns all active tunnels
	Tunnels() []Tunnel
	// Close cleans up and closes all active tunnels
	Close() error
}

func NewTunnelManager

func NewTunnelManager(cfg *config.ClientConfig, logger *slog.Logger, events EventHandler) TunnelManager