server

Documentation

Index

• Constants
• type Option
  • func WithHTTPListenAddrs(addr string) Option
  • func WithHandlerPath(urlPath string) Option
• type Server
  • func NewServer(store store.EncodeableStore, options ...Option) (*Server, error)
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Shutdown(ctx context.Context) error
  • func (s *Server) Start(ctx context.Context) error

Constants

const (
	// IPNIPath is the path that the Publisher expects as the last port of the
	// HTTP request URL path. The sync client automatically adds this to the
	// request path.
	IPNIPath = "/ipni/v1/ad"
)

Types

type Option

type Option func(*config) error

Option is a function that sets a value in a config.

func WithHTTPListenAddrs

func WithHTTPListenAddrs(addr string) Option

WithHTTPListenAddrs sets the HTTP addresse to listen on. These are in addresses:port format

Setting HTTP listen addresses is optional when a stream host is provided by the WithStreamHost option.

func WithHandlerPath

func WithHandlerPath(urlPath string) Option

WithHandlerPath sets the path used to handle requests to this publisher. This specifies the portion of the path before the implicit /ipni/v1/ad/ part of the path. Calling WithHandlerPath("/foo/bar") configures the publisher to handle HTTP requests on the path "/foo/bar/ipni/v1/ad/".

type Server

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

func NewServer

func NewServer(store store.EncodeableStore, options ...Option) (*Server, error)

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP implements the http.Handler interface.

func (*Server) Shutdown

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

func (*Server) Start

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