socket

package

v3.46.1 Latest Latest Go to latest Published: May 8, 2023 License: MIT Imports: 14 Imported by: 0

Details

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

Repository

github.com/buildkite/agent

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package socket provides common implementations for local APIs that use HTTP over Unix domain sockets.

Index ¶

func Available() bool
func GenerateToken(len int) (string, error)
func HeadersMiddleware(headers http.Header) func(http.Handler) http.Handler
func LoggerMiddleware(prefix string, logf func(f string, v ...any)) func(http.Handler) http.Handler
type APIErr
- func (e APIErr) Error() string
type Client
- func NewClient(ctx context.Context, path, token string) (*Client, error)
- func (c *Client) Do(ctx context.Context, method, url string, req, resp any) error
type ErrorResponse
type Server
- func NewServer(socketPath string, handler http.Handler) (*Server, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Available ¶

func Available() bool

func GenerateToken ¶

func GenerateToken(len int) (string, error)

GenerateToken generates a new random token that contains approximately 8*len bits of entropy.

func HeadersMiddleware ¶

func HeadersMiddleware(headers http.Header) func(http.Handler) http.Handler

HeadersMiddleware is a middleware that sets common headers for all responses.

func LoggerMiddleware ¶

func LoggerMiddleware(prefix string, logf func(f string, v ...any)) func(http.Handler) http.Handler

LoggerMiddleware logs all requests (method, URL, and handle time) with the formatted logging function (logf).

Types ¶

type APIErr ¶

type APIErr struct {
	Msg        string
	StatusCode int
}

APIErr is an error type used for API error responses (the API returned a well-formed JSON ErrorResponse and a non-200 status code).

func (APIErr) Error ¶

func (e APIErr) Error() string

type Client ¶

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

Client is a client for a HTTP-over-Unix Domain Socket API.

func NewClient ¶

func NewClient(ctx context.Context, path, token string) (*Client, error)

NewClient creates a new Client. The context is used for an internal check that the socket can be dialled.

func (*Client) Do ¶

func (c *Client) Do(ctx context.Context, method, url string, req, resp any) error

Do implements the common bits of an API call. req is serialised to JSON and passed as the request body if not nil. The method is called, with the token added in the Authorization header. The response is deserialised, either into the object passed into resp if the status is 200 OK, otherwise into an error.

type ErrorResponse ¶

type ErrorResponse struct {
	Error string `json:"error"`
}

Error response is the response body for any errors that occur

type Server ¶

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

Server hosts a HTTP server on a Unix domain socket.

func NewServer ¶

func NewServer(socketPath string, handler http.Handler) (*Server, error)

NewServer creates a server that, when started, will listen on a socket at the given path.

func (*Server) Close ¶

func (s *Server) Close() error

Close immediately closes down the server. Prefer Shutdown for ordinary use.

func (*Server) Shutdown ¶

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

Shutdown calls Shutdown on the inner HTTP server, which closes the socket. Shutdown performs a graceful shutdown, and is preferred over Close.

func (*Server) Start ¶

func (s *Server) Start() error

Start starts the server.

Source Files ¶

View all Source files

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