admin

Documentation

Index

• type Server
  • func NewServer(socketPath string, tunnels []*tunnel.Tunnel) *Server
  • func (s *Server) IsReady() (bool, string)
  • func (s *Server) Run() error

Types

type Server

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

Server is an HTTP server that handles administrative tasks for the agent, such as the authentication handshake performed between the proxy and the agent, and serving a "Hello, world" message.

func NewServer

func NewServer(socketPath string, tunnels []*tunnel.Tunnel) *Server

NewServer creates a new Server with the given ID, binding a listening socket at the given path.

func (*Server) IsReady

func (s *Server) IsReady() (bool, string)

IsReady returns true if the server is ready. If not, it returns a message describing why it is not ready.

func (*Server) Run

func (s *Server) Run() error

Run is a blocking command that starts the Server.