controllers

package

v0.0.0-...-47008de Latest Latest Go to latest Published: Oct 29, 2020 License: GPL-3.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Server : the base elements that make the service

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

GetInverter : handler for getting a single inverter from the DB

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

GetInverters : handler for listing all the inverters in the DB

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

Initialize : prepares the service to launch

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

RefreshInverterCollection : deletes all the inverters in the DB

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

RefreshTelemetryDataCollection : deletes all the telemetry data in the DB

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

Run : runs the service and recovers errors

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

SetupInverterCollection : setups the inverter collection with constraints and rules

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

SetupTelemetryDataCollection : setups the telemetry data collection with constraints and rules

func (s *Server) Terminate() error

Terminate : closes connections and ends the service