tunnel

Documentation

Index

• Variables
• type Params
• type Result
• type SecretKey
• type Service
• type Tunnel
• type TunnelCreate
• type TunnelPartial
• type TunnelUpdate

Variables

var Module = fx.Module("tunnel", fx.Provide(newModule))

Module

Types

type Params

type Params struct {
	fx.In

	Logger *zap.Logger

	DB database.DBTX

	Auth auth.Authenticator
}

Params

type Result

type Result struct {
	fx.Out

	Transport gateway.Transport `group:"transport"`

	TunnelService Service `name:"tunnel_service"`
}

Result

type SecretKey

type SecretKey struct {
	Secret string
}

SecretKey

type Service

type Service interface {
	// Create
	Create(context.Context, TunnelCreate) (Tunnel, SecretKey, error)
	// Get
	Get(context.Context, string) (Tunnel, error)
	// List
	List(context.Context, int32, int32) ([]TunnelPartial, error)
	// Update
	Update(context.Context, TunnelUpdate) (Tunnel, error)
	// Delete
	Delete(context.Context, string) error

	// VerifyToken
	VerifyToken(context.Context, string) (string, error)

	// Health
	Health(context.Context) error
}

Service

type Tunnel

type Tunnel struct {
	ID        string
	Name      string
	CreatedAt time.Time
	UpdatedAt *time.Time
}

Tunnel

type TunnelCreate

type TunnelCreate struct {
	Name string
}

TunnelCreate

type TunnelPartial

type TunnelPartial struct {
	ID        string
	Name      string
	CreatedAt time.Time
}

TunnelPartial

type TunnelUpdate

type TunnelUpdate struct {
	OldName string
	Name    string
}

TunnelUpdate