server

package

v1.2.2 Latest Latest Go to latest Published: Aug 10, 2022 License: MIT Imports: 10 Imported by: 6

Details

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

Repository

github.com/anycable/anycable-go

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func HealthHandler(w http.ResponseWriter, _ *http.Request)
type HTTPServer
- func ForPort(port string) (*HTTPServer, error)
- func NewServer(host string, port string, ssl *SSLConfig, maxConn int) (*HTTPServer, error)
type SSLConfig
- func NewSSLConfig() SSLConfig
- func (opts *SSLConfig) Available() bool

Constants ¶

This section is empty.

Variables ¶

View Source

var (

	// Host is a default bind address for HTTP servers
	Host string = "localhost"
	// SSL is a default configuration for HTTP servers
	SSL *SSLConfig
	// MaxConn is a default configuration for maximum connections
	MaxConn int
)

Functions ¶

func HealthHandler ¶ added in v1.0.1

func HealthHandler(w http.ResponseWriter, _ *http.Request)

HealthHandler always reponds with 200 status

Types ¶

type HTTPServer ¶

type HTTPServer struct {
	Mux *http.ServeMux
	// contains filtered or unexported fields
}

HTTPServer is wrapper over http.Server

func ForPort ¶ added in v1.0.1

func ForPort(port string) (*HTTPServer, error)

ForPort creates new or returns the existing server for the specified port

func NewServer ¶

func NewServer(host string, port string, ssl *SSLConfig, maxConn int) (*HTTPServer, error)

NewServer builds HTTPServer from config params

func (*HTTPServer) Address ¶

func (s *HTTPServer) Address() string

Address returns server scheme://host:port

func (*HTTPServer) Running ¶ added in v1.0.1

func (s *HTTPServer) Running() bool

Running returns true if server has been started

func (*HTTPServer) Shutdown ¶ added in v1.1.0

func (s *HTTPServer) Shutdown() error

Shutdown shuts down server gracefully.

func (*HTTPServer) Start ¶

func (s *HTTPServer) Start() error

Start server

func (*HTTPServer) StartAndAnnounce ¶ added in v1.0.1

func (s *HTTPServer) StartAndAnnounce(name string) error

StartAndAnnounce prints server info and starts server

func (*HTTPServer) Stopped ¶

func (s *HTTPServer) Stopped() bool

Stopped return true iff server has been stopped by user

type SSLConfig ¶ added in v1.0.1

type SSLConfig struct {
	CertPath string
	KeyPath  string
}

SSLConfig contains SSL parameters

func NewSSLConfig ¶ added in v1.0.1

func NewSSLConfig() SSLConfig

NewSSLConfig build a new SSLConfig struct

func (*SSLConfig) Available ¶ added in v1.0.1

func (opts *SSLConfig) Available() bool

Available returns true iff certificate and private keys are set

Source Files ¶

View all Source files

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