server

package

v0.0.0-...-2b84898 Latest Latest Go to latest Published: Nov 1, 2024 License: MIT Imports: 17 Imported by: 0

Details

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

Repository

github.com/worldline-go/telemetry_example

Links

Open Source Insights

Documentation ¶

Index ¶

type Router
- func NewRouter(rs RouterSettings, handler *handler.Handler) *Router
type RouterSettings
- func (rs RouterSettings) SetDefaults() RouterSettings

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Router ¶

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

func NewRouter ¶

func NewRouter(rs RouterSettings, handler *handler.Handler) *Router

func (*Router) Register ¶

func (r *Router) Register(basePath string, middlewares []echo.MiddlewareFunc, h *handler.Handler)

Register

@title Telemetry @version 1.0 @description telemetry example project

@contact.name @FINOPS @contact.email @FINOPS

@host @BasePath /api/v1

func (*Router) Start ¶

func (r *Router) Start() error

func (*Router) Stop ¶

func (r *Router) Stop() error

func (*Router) StopWithContext ¶

func (r *Router) StopWithContext(ctx context.Context, wg *sync.WaitGroup)

type RouterSettings ¶

type RouterSettings struct {
	// Addr like 0.0.0.0:8080
	Addr string
	// BasePath for serving
	BasePath string
	// ShutdownTimeout using in shutdown server default is 5 second.
	ShutdownTimeout time.Duration
}

func (RouterSettings) SetDefaults ¶

func (rs RouterSettings) SetDefaults() RouterSettings

Source Files ¶

View all Source files

server.go

Directories ¶

Path	Synopsis
handler

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