controllers

Documentation

Index

• type Server
  • func (s *Server) GetInverter(c *gin.Context)
  • func (s *Server) GetInverters(c *gin.Context)
  • func (s *Server) Initialize(DBHost, DBPort, DBUser, DBPassword, DBDatabase, mode string) error
  • func (s *Server) RefreshInverterCollection(ctx context.Context) error
  • func (s *Server) RefreshTelemetryDataCollection(ctx context.Context) error
  • func (s *Server) Run(servicePort string) error
  • func (s *Server) SetupInverterCollection(ctx context.Context) error
  • func (s *Server) SetupTelemetryDataCollection(ctx context.Context) error
  • func (s *Server) Terminate() error

Types

type Server

type Server struct {
	DB     *mongo.Database
	Router *gin.Engine
}

Server : the base elements that make the service

func (*Server) GetInverter

func (s *Server) GetInverter(c *gin.Context)

GetInverter : handler for getting a single inverter from the DB

func (*Server) GetInverters

func (s *Server) GetInverters(c *gin.Context)

GetInverters : handler for listing all the inverters in the DB

func (*Server) Initialize

func (s *Server) Initialize(DBHost, DBPort, DBUser, DBPassword, DBDatabase, mode string) error

Initialize : prepares the service to launch

func (*Server) RefreshInverterCollection

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

RefreshInverterCollection : deletes all the inverters in the DB

func (*Server) RefreshTelemetryDataCollection

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

RefreshTelemetryDataCollection : deletes all the telemetry data in the DB

func (*Server) Run

func (s *Server) Run(servicePort string) error

Run : runs the service and recovers errors

func (*Server) SetupInverterCollection

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

SetupInverterCollection : setups the inverter collection with constraints and rules

func (*Server) SetupTelemetryDataCollection

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

SetupTelemetryDataCollection : setups the telemetry data collection with constraints and rules

func (*Server) Terminate

func (s *Server) Terminate() error

Terminate : closes connections and ends the service