rpc

package

v0.4.18 Latest Latest Go to latest Published: Apr 23, 2024 License: Apache-2.0 Imports: 29 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

Repository

github.com/yorkie-team/yorkie

Links

Open Source Insights

Documentation ¶

Overview ¶

Package rpc provides the rpc server which is responsible for handling requests from the client.

Index ¶

Variables
type Config
- func (c *Config) Validate() error
type Server
- func NewServer(conf *Config, be *backend.Backend) (*Server, error)
- func (s *Server) Shutdown(graceful bool)
- func (s *Server) Start() error

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrInvalidRPCPort occurs when the port in the config is invalid.
	ErrInvalidRPCPort = errors.New("invalid port number for RPC server")
	// ErrInvalidCertFile occurs when the certificate file is invalid.
	ErrInvalidCertFile = errors.New("invalid cert file for RPC server")
	// ErrInvalidKeyFile occurs when the key file is invalid.
	ErrInvalidKeyFile = errors.New("invalid key file for RPC server")
)

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	// Port is the port number for the RPC server.
	Port int `yaml:"Port"`

	// CertFile is the path to the certificate file.
	CertFile string `yaml:"CertFile"`

	// KeyFile is the path to the key file.
	KeyFile string `yaml:"KeyFile"`
}

Config is the configuration for creating a Server instance.

func (*Config) Validate ¶

func (c *Config) Validate() error

Validate validates the port number and the files for certification.

type Server ¶

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

Server is a normal server that processes the logic requested by the client.

func NewServer ¶

func NewServer(conf *Config, be *backend.Backend) (*Server, error)

NewServer creates a new instance of Server.

func (*Server) Shutdown ¶

func (s *Server) Shutdown(graceful bool)

Shutdown shuts down this server.

func (*Server) Start ¶

func (s *Server) Start() error

Start starts this server by opening the rpc port.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
auth Package auth provides authentication and authorization for RPCs.	Package auth provides authentication and authorization for RPCs.
connecthelper Package connecthelper provides helper functions for connectRPC.	Package connecthelper provides helper functions for connectRPC.
interceptors Package interceptors provides the interceptors for RPC.	Package interceptors provides the interceptors for RPC.
metadata Package metadata provides metadata for RPC.	Package metadata provides metadata for RPC.
testcases Package testcases contains testcases for server	Package testcases contains testcases for server

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL