endpoint

package

v0.6.2 Latest Latest Go to latest Published: Jun 5, 2023 License: Apache-2.0 Imports: 38 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/viant/mly

Links

Open Source Insights

Documentation ¶

Index ¶

func IsHelpOption(args []string) bool
func NewConfigHandler(config *Config) http.Handler
func NewHealthHandler(config *Config) *healthHandler
func NewProfHandler(config *Config) *profHandler
func RunApp(Version string, args []string, wg *sync.WaitGroup)
func RunAppError(Version string, args []string, wg *sync.WaitGroup) error
func RunAppWithConfig(Version string, args []string, ...)
func RunAppWithConfigError(Version string, args []string, ...) error
type Config
- func NewConfigFromURL(ctx context.Context, URL string) (*Config, error)
type Options
type Service
- func New(config *Config) (*Service, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func IsHelpOption ¶

func IsHelpOption(args []string) bool

IsHelpOption returns true if helper

func NewConfigHandler ¶

func NewConfigHandler(config *Config) http.Handler

NewConfigHandler creates a config handler

func NewHealthHandler ¶ added in v0.3.0

func NewHealthHandler(config *Config) *healthHandler

func NewProfHandler ¶ added in v0.4.0

func NewProfHandler(config *Config) *profHandler

func RunApp ¶

func RunApp(Version string, args []string, wg *sync.WaitGroup)

RunApp run application

func RunAppError ¶ added in v0.4.0

func RunAppError(Version string, args []string, wg *sync.WaitGroup) error

func RunAppWithConfig ¶

func RunAppWithConfig(Version string, args []string, configProvider func(options *Options) (*Config, error))

RunAppWithConfig run application

func RunAppWithConfigError ¶ added in v0.4.0

func RunAppWithConfigError(Version string, args []string, configProvider func(options *Options) (*Config, error)) error

Types ¶

type Config ¶

type Config struct {
	config.ModelList      `json:",omitempty" yaml:",inline"`
	sconfig.DatastoreList `json:",omitempty" yaml:",inline"`
	Endpoint              econfig.Endpoint
	EnableMemProf         bool
	AllowedSubnet         []string `json:",omitempty" yaml:",omitempty"`
}

Config represents an endpoint config

func NewConfigFromURL ¶

func NewConfigFromURL(ctx context.Context, URL string) (*Config, error)

NewConfigFromURL creates a new config from URL

func (*Config) Init ¶

func (c *Config) Init()

Init initialise config

func (*Config) LoadFromURL ¶

func (c *Config) LoadFromURL(ctx context.Context, URL string, target interface{}) error

func (*Config) Validate ¶

func (c *Config) Validate() error

Validate validates config

type Options ¶

type Options struct {
	ConfigURL string `short:"c" long:"cfg" description:"config URI"`
	Version   bool   `short:"v" long:"version" description:"indexer version"`
}

Options represents an option

type Service ¶

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

Service represents http bridge

func New ¶

func New(config *Config) (*Service, error)

New creates a bridge Service

func (*Service) Listen ¶ added in v0.6.0

func (s *Service) Listen() (net.Listener, error)

func (*Service) ListenAndServe ¶

func (s *Service) ListenAndServe() error

Deprecated

func (*Service) ListenAndServeTLS ¶

func (s *Service) ListenAndServeTLS(certFile, keyFile string) error

ListenAndServeTLS start https endpoint on secure port

func (*Service) Metric ¶

func (s *Service) Metric() *gmetric.Service

Metric returns operation metrics

func (*Service) SelfTest ¶ added in v0.6.0

func (s *Service) SelfTest() error

func (*Service) Serve ¶ added in v0.6.0

func (s *Service) Serve(l net.Listener) error

func (*Service) Shutdown ¶

func (s *Service) Shutdown(ctx context.Context) error

Shutdown stops server

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
checker
config

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL