routes

Documentation

Index

• Variables
• type Params
• type Result
• type Route
• type RouteCreate
• type RouteList
• type RoutePartial
• type RouteUpdate
• type Service

Variables

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

Module

Types

type Params

type Params struct {
	fx.In

	Logger *zap.Logger

	DBTX database.DBTX
}

Params

type Result

type Result struct {
	fx.Out

	Transport gateway.Transport `group:"transport"`
}

Result

type Route

type Route struct {
	ID                  string
	Tunnel              string
	Hostname            string
	DestinationProtocol string
	DestinationIP       string
	DestinationPort     uint32
	Enabled             bool
	CreatedAt           time.Time
	UpdatedAt           *time.Time
}

Route

type RouteCreate

type RouteCreate struct {
	Tunnel string

	Hostname string

	DestinationProtocol string
	DestinationIP       string
	DestinationPort     uint32
}

RouteCreate

type RouteList

type RouteList struct {
	Tunnel        string
	Limit, Offset int32
}

RouteList

type RoutePartial

type RoutePartial struct {
	ID        string
	Hostname  string
	Enabled   bool
	CreatedAt time.Time
}

RoutePartial

type RouteUpdate

type RouteUpdate struct {
	ID                  string
	Hostname            string
	DestinationProtocol string
	DestinationIP       string
	DestinationPort     uint32
	Enabled             bool
}

RouteUpdate

type Service

type Service interface {
	// Create
	Create(context.Context, RouteCreate) (Route, error)
	// Get
	Get(context.Context, string) (Route, error)
	// List
	List(context.Context, RouteList) ([]RoutePartial, error)
	// Update
	Update(context.Context, RouteUpdate) (Route, error)
	// Delete
	Delete(context.Context, string) error

	// Active
	Active(context.Context, string) (Route, error)
}

Service