coild

Documentation

Index

• Variables
• type APIError
  • func BadRequest(reason string) APIError
  • func InternalServerError(e error) APIError
  • func (e APIError) Error() string
• type Server
  • func NewServer(db model.Model, tableID, protocolID int) *Server
  • func (s *Server) Init(ctx context.Context) error
  • func (s *Server) ScanLoop(ctx context.Context, scanInterval time.Duration) error
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

Variables

var (
	APIErrBadRequest     = APIError{http.StatusBadRequest, "invalid request", nil}
	APIErrForbidden      = APIError{http.StatusForbidden, "forbidden", nil}
	APIErrNotFound       = APIError{http.StatusNotFound, "requested resource is not found", nil}
	APIErrBadMethod      = APIError{http.StatusMethodNotAllowed, "method not allowed", nil}
	APIErrConflict       = APIError{http.StatusConflict, "conflicted", nil}
	APIErrLengthRequired = APIError{http.StatusLengthRequired, "content-length is required", nil}
	APIErrTooLargeAsset  = APIError{http.StatusRequestEntityTooLarge, "too large asset", nil}
)

Common API errors

Types

type APIError

type APIError struct {
	Status  int
	Message string
	Err     error
}

APIError is to define REST API errors.

func BadRequest

func BadRequest(reason string) APIError

BadRequest creates an APIError that describes what was bad in the request.

func InternalServerError

func InternalServerError(e error) APIError

InternalServerError creates an APIError.

func (APIError) Error

func (e APIError) Error() string

Error implements error interface.

type Server

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

Server keeps coild internal status.

func NewServer

func NewServer(db model.Model, tableID, protocolID int) *Server

NewServer creates a new Server.

func (*Server) Init

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

Init loads status data from the database.

func (*Server) ScanLoop

func (s *Server) ScanLoop(ctx context.Context, scanInterval time.Duration) error

ScanLoop scans IP address assignment table and Pods information periodically.

func (*Server) ServeHTTP

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

ServeHTTP implements http.Handler.