services

Documentation

Index

• Variables
• func IsTypeValid(s string) bool
• func TypeConfiguredOptions(serviceType string) (service.Options, error)
• func Types() []string
• type ServiceOptionsParser
  • func TypeJSONParser(serviceType string) (ServiceOptionsParser, error)
• type StartOptions
  • func GetStartOptions(serviceType string) (opts StartOptions, err error)

Variables

var JSONParsersByType = map[string]ServiceOptionsParser{
	noop.ServiceType:         noop.ParseJSONOptions,
	openvpn.ServiceType:      openvpn_service.ParseJSONOptions,
	wireguard.ServiceType:    wireguard_service.ParseJSONOptions,
	scraping.ServiceType:     wireguard_service.ParseJSONOptions,
	datatransfer.ServiceType: wireguard_service.ParseJSONOptions,
	dvpn.ServiceType:         wireguard_service.ParseJSONOptions,
}

JSONParsersByType parsers of service specific options from JSON request.

Functions

func IsTypeValid

func IsTypeValid(s string) bool

IsTypeValid returns true if a given string is valid service type.

func TypeConfiguredOptions

func TypeConfiguredOptions(serviceType string) (service.Options, error)

TypeConfiguredOptions returns specific service options.

func Types

func Types() []string

Types returns all possible service types.

Types

type ServiceOptionsParser

type ServiceOptionsParser func(*json.RawMessage) (service.Options, error)

ServiceOptionsParser parses request to service specific options

func TypeJSONParser

func TypeJSONParser(serviceType string) (ServiceOptionsParser, error)

TypeJSONParser get parser to parse service specific options from JSON request.

type StartOptions

type StartOptions struct {
	AccessPolicyList []string
	TypeOptions      service.Options
}

StartOptions describes options shared among multiple services

func GetStartOptions

func GetStartOptions(serviceType string) (opts StartOptions, err error)

GetStartOptions returns options to use for starting a service.