server

package
v4.1.21 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 11, 2025 License: GPL-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ConfigUpdateOutput

type ConfigUpdateOutput struct {
	Body *gpapi.ConfigUpdateResponse
}

ConfigUpdateOutput returns the updated interfaces

type GetConfigOutput

type GetConfigOutput struct {
	Status int
	Body   *gpapi.ConfigResponse
}

GetConfigOutput returns the interface config(s) fetched during a config request

type GetIfaceConfigInput

type GetIfaceConfigInput struct {
	Iface string `path:"iface" doc:"Interface to get configuration from" minLength:"2"`
}

GetIfaceConfigInput describes the input to a config request for a single interface

type GetIfaceStatusInput

type GetIfaceStatusInput struct {
	Iface string `path:"iface" doc:"Interface to get status from" minLength:"2"`
}

GetIfaceStatusInput describes the input to a status request for a single interface

type GetIfacesConfigInput

type GetIfacesConfigInput struct {
	Ifaces []string `query:"ifaces" doc:"Interfaces to get configuration from" required:"false" minItems:"1"`
}

GetIfacesConfigInput describes the input to a config request for multiple interfaces

type GetIfacesStatusInput

type GetIfacesStatusInput struct {
	Ifaces []string `query:"ifaces" doc:"Interfaces to get status from" required:"false" minItems:"1"`
}

GetIfacesStatusInput describes the input to a status request

type GetStatusOutput

type GetStatusOutput struct {
	Status int
	Body   *gpapi.StatusResponse
}

GetStatusOutput returns the status fetched during a status request

type PutConfigInput

type PutConfigInput struct {
	Body config.Ifaces
}

PutConfigInput is the input to a config update

type Server

type Server struct {
	*server.DefaultServer
	// contains filtered or unexported fields
}

Server runs a goprobe API server

func New

func New(addr, dbPath string, captureManager *capture.Manager, configMonitor *config.Monitor, opts ...server.Option) *Server

New creates a new goprobe API server

Jump to

Keyboard shortcuts

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