grpc

Documentation

Overview

Copyright 2023 The Simila Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• type Config
  • func (c *Config) String() string
• type RegisterF
• type Server
  • func NewServer(cfg Config) *Server
  • func (s *Server) Init(ctx context.Context) error
  • func (s *Server) Shutdown()

Types

type Config

type Config struct {
	// A network transport configuration
	Transport transport.Config
	// RegisterEndpoints allows to add gRPC endpoints into the server
	RegisterEndpoints RegisterF
}

Config is used for providing settings to the server

func (*Config) String

func (c *Config) String() string

String implements fmt.Stringify

type RegisterF

type RegisterF func(*grpc.Server) error

RegisterF is a function which allows to add endpoints into the server. It is called in Init

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server provides gRPC server interface. it can be used by one or many versions. The Server is about transport layer, it doesn't provide any specific details like concrete APIs, which should be registered in RegisterF function callback, provided in the Server config.

func NewServer

func NewServer(cfg Config) *Server

NewServer creates a new instance of the Server

func (*Server) Init

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

Init is part of linker.Initializer. it is called by the dependency injection mechanism, so it must be called once and it is not thread-safe

func (*Server) Shutdown

func (s *Server) Shutdown()

Shutdown is an implementation of linker.Shutdowner. It must be called once, not thread-safe.