gatewayconfigurationserver

Documentation

Index

• type Config
• type Server
  • func New(c *component.Component, conf *Config) (*Server, error)
  • func (s *Server) GetGatewayConfiguration(ctx context.Context, req *ttnpb.GetGatewayConfigurationRequest) (*ttnpb.GetGatewayConfigurationResponse, error)
  • func (s *Server) RegisterHandlers(mux *runtime.ServeMux, conn *grpc.ClientConn)
  • func (s *Server) RegisterRoutes(server *web.Server)
  • func (s *Server) RegisterServices(grpcServer *grpc.Server)
  • func (s *Server) Roles() []ttnpb.ClusterRole

Types

type Config

type Config struct {
	// BasicStation defines the configuration for the BasicStation CUPS.
	BasicStation bscups.ServerConfig `name:"basic-station" description:"BasicStation CUPS configuration."`
	// TheThingsGateway defines the configuration for The Things Gateway CUPS.
	TheThingsGateway gcsv2.TheThingsGatewayConfig `name:"the-things-gateway" description:"The Things Gateway CUPS configuration."`
	// RequreAuth defines if the HTTP endpoints should require authentication or not.
	RequireAuth bool `name:"require-auth" description:"Require authentication for the HTTP endpoints."`
}

Config contains the Gateway Configuration Server configuration.

type Server

type Server struct {
	ttnpb.UnimplementedGatewayConfigurationServiceServer

	*component.Component
	// contains filtered or unexported fields
}

Server implements the Gateway Configuration Server component.

func New

func New(c *component.Component, conf *Config) (*Server, error)

New returns new *Server.

func (*Server) GetGatewayConfiguration

func (s *Server) GetGatewayConfiguration(ctx context.Context, req *ttnpb.GetGatewayConfigurationRequest) (*ttnpb.GetGatewayConfigurationResponse, error)

GetGatewayConfiguration validates the request fields and returns the appropriate gateway configuration

func (*Server) RegisterHandlers

func (s *Server) RegisterHandlers(mux *runtime.ServeMux, conn *grpc.ClientConn)

RegisterHandlers registers gRPC handlers.

func (*Server) RegisterRoutes

func (s *Server) RegisterRoutes(server *web.Server)

RegisterRoutes registers the web frontend routes.

The gateway configuration value returned by the `grpc-gateway` routes are not content formatted, but a stream of bytes. This would be a breaking change for the consumers of this API and hence these routes are retained.

func (*Server) RegisterServices

func (s *Server) RegisterServices(grpcServer *grpc.Server)

RegisterServices registers services provided by gcs at s.

func (*Server) Roles

func (s *Server) Roles() []ttnpb.ClusterRole

Roles returns the roles that the Gateway Configuration Server fulfills.