server

Documentation

Overview

Package server is for all the SPV Wallet settings and HTTP server

Index

• func SetupServerRoutes(appConfig *config.AppConfig, services *config.AppServices, engine *gin.Engine)
• type Server
  • func NewServer(appConfig *config.AppConfig, services *config.AppServices) *Server
  • func (s *Server) Handlers() *gin.Engine
  • func (s *Server) Serve()
  • func (s *Server) Shutdown(ctx context.Context) error
• type WriterFunc
  • func (f WriterFunc) Write(p []byte) (n int, err error)

Functions

func SetupServerRoutes

func SetupServerRoutes(appConfig *config.AppConfig, services *config.AppServices, engine *gin.Engine)

SetupServerRoutes will register endpoints for all models

Types

type Server

type Server struct {
	AppConfig *config.AppConfig
	Router    *gin.Engine
	Services  *config.AppServices
	WebServer *http.Server
}

Server is the configuration, services, and actual web server

func NewServer

func NewServer(appConfig *config.AppConfig, services *config.AppServices) *Server

NewServer will return a new server service

func (*Server) Handlers

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

Handlers will return handlers

func (*Server) Serve

func (s *Server) Serve()

Serve will load a server and start serving

func (*Server) Shutdown

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

Shutdown will stop the web server

type WriterFunc

type WriterFunc func(p []byte) (n int, err error)

WriterFunc wrapper type for function that is implementing io.Writer interface.

func (WriterFunc) Write

func (f WriterFunc) Write(p []byte) (n int, err error)

Write proxy to implement io.Writer interface.