api

Documentation

Overview

Package api implements the agent IPC api. Using HTTP calls, it's possible to communicate with the agent, sending commands and receiving infos.

Index

• type Server
  • func NewServer(statusComponent status.Component, settings settings.Component) (*Server, error)
  • func (s *Server) Address() *net.TCPAddr
  • func (s *Server) Start() error
  • func (s *Server) Stop()

Types

type Server

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

Server implements security agent API server

func NewServer

func NewServer(statusComponent status.Component, settings settings.Component) (*Server, error)

NewServer creates a new Server instance

func (*Server) Address

func (s *Server) Address() *net.TCPAddr

Address retruns the server address.

func (*Server) Start

func (s *Server) Start() error

Start creates the router and starts the HTTP server

func (*Server) Stop

func (s *Server) Stop()

Stop closes the connection and the server stops listening to new commands.