actions

Documentation

Index

• type Actions
  • func (a *Actions) CreateRelay(ctx context.Context, relayOpts *opts.RelayOptions) (*types.Relay, error)
  • func (a *Actions) CreateTunnel(reqCtx context.Context, tunnelOpts *opts.TunnelOptions) (*types.Tunnel, error)
  • func (a *Actions) DeleteRelay(ctx context.Context, relayID string) (*types.Relay, error)
  • func (a *Actions) DeleteTunnel(ctx context.Context, tunnelID string) error
  • func (a *Actions) ResumeRelay(ctx context.Context, relayID string) (*types.Relay, error)
  • func (a *Actions) ResumeTunnel(ctx context.Context, tunnelID string) (*types.Tunnel, error)
  • func (a *Actions) StopRelay(ctx context.Context, relayID string) (*types.Relay, error)
  • func (a Actions) StopTunnel(ctx context.Context, tunnelID string) (*types.Tunnel, error)
  • func (a *Actions) UpdateRelay(ctx context.Context, relayID string, relayOpts *opts.RelayOptions) (*types.Relay, error)
  • func (a *Actions) UpdateTunnel(ctx context.Context, tunnelID string, tunnelOpts *opts.TunnelOptions) (*types.Tunnel, error)
• type Config
• type IActions
  • func New(cfg *Config) (IActions, error)

Types

type Actions

type Actions struct {
	// contains filtered or unexported fields
}

func (*Actions) CreateRelay

func (a *Actions) CreateRelay(ctx context.Context, relayOpts *opts.RelayOptions) (*types.Relay, error)

func (*Actions) CreateTunnel

func (a *Actions) CreateTunnel(reqCtx context.Context, tunnelOpts *opts.TunnelOptions) (*types.Tunnel, error)

func (*Actions) DeleteRelay

func (a *Actions) DeleteRelay(ctx context.Context, relayID string) (*types.Relay, error)

DeleteRelay stops a relay (if active) and delete it from persistent storage

func (*Actions) DeleteTunnel

func (a *Actions) DeleteTunnel(ctx context.Context, tunnelID string) error

func (*Actions) ResumeRelay

func (a *Actions) ResumeRelay(ctx context.Context, relayID string) (*types.Relay, error)

func (*Actions) ResumeTunnel

func (a *Actions) ResumeTunnel(ctx context.Context, tunnelID string) (*types.Tunnel, error)

func (*Actions) StopRelay

func (a *Actions) StopRelay(ctx context.Context, relayID string) (*types.Relay, error)

func (Actions) StopTunnel

func (a Actions) StopTunnel(ctx context.Context, tunnelID string) (*types.Tunnel, error)

func (*Actions) UpdateRelay

func (a *Actions) UpdateRelay(ctx context.Context, relayID string, relayOpts *opts.RelayOptions) (*types.Relay, error)

func (*Actions) UpdateTunnel

func (a *Actions) UpdateTunnel(ctx context.Context, tunnelID string, tunnelOpts *opts.TunnelOptions) (*types.Tunnel, error)

type Config

type Config struct {
	PersistentConfig *config.Config
}

type IActions

type IActions interface {
	// relay
	CreateRelay(ctx context.Context, relayOpts *opts.RelayOptions) (*types.Relay, error)
	DeleteRelay(context.Context, string) (*types.Relay, error)
	StopRelay(ctx context.Context, relayID string) (*types.Relay, error)
	ResumeRelay(ctx context.Context, relayID string) (*types.Relay, error)
	UpdateRelay(ctx context.Context, relayID string, relayOpts *opts.RelayOptions) (*types.Relay, error)

	// tunnel
	CreateTunnel(reqCtx context.Context, tunnelOpts *opts.TunnelOptions) (*types.Tunnel, error)
	ResumeTunnel(ctx context.Context, tunnelID string) (*types.Tunnel, error)
	StopTunnel(ctx context.Context, tunnelID string) (*types.Tunnel, error)
	UpdateTunnel(ctx context.Context, tunnelID string, tunnelOpts *opts.TunnelOptions) (*types.Tunnel, error)
	DeleteTunnel(ctx context.Context, tunnelID string) error
}

func New

func New(cfg *Config) (IActions, error)