resthttp

Documentation

Index

• Variables
• type Options
• type Server
  • func NewServer(opt *Options) *Server
  • func (s *Server) Serve() error
  • func (s *Server) URL() string

Variables

var (
	DefaultOpt = Options{
		ListenAddr:         "localhost:8080",
		Realm:              "honey",
		ServerReadTimeout:  60 * time.Second,
		ServerWriteTimeout: 60 * time.Second,
		MaxHeaderBytes:     4096,
	}
)

Types

type Options

type Options struct {
	ListenAddr         string        // Port to listen on
	BaseURL            string        // prefix to strip from URLs
	ServerReadTimeout  time.Duration // Timeout for server reading data
	ServerWriteTimeout time.Duration // Timeout for server writing data
	MaxHeaderBytes     int           // Maximum size of request header
	SslCert            string        // SSL PEM key (concatenation of certificate and CA certificate)
	SslKey             string        // SSL PEM Private key
	ClientCA           string        // Client certificate authority to verify clients with
	Realm              string        // realm for authentication
	BasicUser          string        // single username for basic auth
	BasicPass          string        // password for BasicUser
	UI                 bool          // enable ui
}

type Server

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

func NewServer

func NewServer(opt *Options) *Server

NewServer _

func (*Server) Serve

func (s *Server) Serve() error

func (*Server) URL

func (s *Server) URL() string

URL returns the serving address of this server