sock

package

v1.0.5 Latest Latest Go to latest Published: Mar 29, 2024 License: GPL-3.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	ErrTimeout           = fmt.Errorf("unix socket timeout")
	ErrConnectionRefused = fmt.Errorf("unix socket connection failed")
)

View Source

var (
	ErrServerRequestedShutdown = errors.New("socket frontend is requested to shutdown")
)

This section is empty.

type Client struct {
	Addr string
}

Client is a unix socket client that can send requests to the frontend over HTTP.

func (cl *Client) Request(method, url string) (string, error)

Request sends a request to the frontend and returns the response.

type Config struct {
	Addr        string
	HandlerFunc HttpHandlerFunc
}

type HttpHandlerFunc func(w http.ResponseWriter, r *http.Request)

HttpHandlerFunc is a function that handles HTTP requests.

type Server struct {
	*Config
	// contains filtered or unexported fields
}

Server is a unix socket frontend that passes http requests to HandlerFunc.

func NewServer(c *Config) (*Server, error)

NewServer creates a new unix socket frontend.

func (svr *Server) Serve(listen chan error) error

Serve starts listening and serving requests.

func (svr *Server) Shutdown() error

Shutdown stops the frontend.