server

Documentation

Overview

Smart home gate

This documentation describes APIs found under https://github.com/e154/smart-home-gate

BasePath: /
Version: 1.0.0
License: MIT https://raw.githubusercontent.com/e154/smart-home-gate/master/LICENSE
Contact: Alex Filippov <support@e154.ru> https://e154.github.io/smart-home-gate/

Consumes:
- application/json

Produces:
- application/json

Security:
- ApiKeyAuth
- ServerAuthorization

SecurityDefinitions:
ApiKeyAuth:
     type: apiKey
     name: Authorization
     in: header
ServerAuthorization:
     type: apiKey
     name: ServerAuthorization
     in: header

swagger:meta

Index

• type Server
  • func NewServer(cfg *ServerConfig, controllers *controllers.Controllers, ...) (newServer *Server)
  • func (s *Server) GetEngine() *gin.Engine
  • func (s *Server) Shutdown()
  • func (s *Server) Start()
• type ServerConfig
  • func NewServerConfig(cfg *config.AppConfig) *ServerConfig
• type ServerLogger
  • func (s ServerLogger) Write(b []byte) (i int, err error)

Types

type Server

type Server struct {
	Config      *ServerConfig
	Controllers *controllers.Controllers
	// contains filtered or unexported fields
}

func NewServer

func NewServer(cfg *ServerConfig,
	controllers *controllers.Controllers,
	streamService *stream.StreamService) (newServer *Server)

func (*Server) GetEngine

func (s *Server) GetEngine() *gin.Engine

func (*Server) Shutdown

func (s *Server) Shutdown()

func (*Server) Start

func (s *Server) Start()

type ServerConfig

type ServerConfig struct {
	Host string
	Port int
}

func NewServerConfig

func NewServerConfig(cfg *config.AppConfig) *ServerConfig

type ServerLogger

type ServerLogger struct {
	Logger *logging.Logger
}

func (ServerLogger) Write

func (s ServerLogger) Write(b []byte) (i int, err error)