grpc

Documentation

Index

• type Client
  • func (c *Client) Close(ctx context.Context) error
  • func (c *Client) Dial(ctx context.Context, cfg ConfigClient) error
• type Config
• type ConfigClient
• type ErrPermissionForbidden
  • func (e ErrPermissionForbidden) Error() string
• type ErrUninitialized
  • func (err ErrUninitialized) Error() string
• type Service
  • func (s *Service) Close(ctx context.Context) error
  • func (s *Service) Dial(ctx context.Context, cfg Config) error
  • func (s *Service) Serve(ctx context.Context) error

Types

type Client

type Client struct {
	*grpc.ClientConn
}

func (*Client) Close

func (c *Client) Close(ctx context.Context) error

func (*Client) Dial

func (c *Client) Dial(ctx context.Context, cfg ConfigClient) error

type Config

type Config struct {
	Hostname string `json:"hostname" env:"GRPC_HOSTNAME" env-default:"0.0.0.0"`
	Port     string `json:"port" env:"PORT" env-default:"8080"`

	ConnectionTimeout uint `json:"connection_timeout" env:"GRPC_CONNECTION_TIMEOUT"`
	NumStreamWorkers  uint `json:"num_stream_workers" env:"GRPC_NUM_STREAM_WORKERS"`
	MaxRecvMsgSize    uint `json:"max_recv_msg_size" env:"GRPC_MAX_RECV_MSG_SIZE"`

	Origin map[string]interface{} `json:"origin" env:"GRPC_ORIGIN"`

	ForceStop bool `json:"force_stop" env:"FORCE_STOP"`
}

Config is grpc service config.

type ConfigClient

type ConfigClient struct {
	Hostname string `json:"hostname" env:"GRPC_CLIENT_HOSTNAME" env-default:"0.0.0.0"`
	Port     string `json:"port" env:"GRPC_CLIENT_PORT" env-default:"8080"`

	Cert string `json:"cert" env:"GRPC_CLIENT_CERT"`
	Key  string `json:"key" env:"GRPC_CLIENT_KEY"`

	MaxSendMsgSize uint `json:"max_send_msg_size" env:"GRPC_MAX_SEND_MSG_SIZE"`
}

Config is grpc client config.

type ErrPermissionForbidden

type ErrPermissionForbidden struct{}

ErrPermissionForbidden is raised when a user tries to access a forbidden resource.

func (ErrPermissionForbidden) Error

func (e ErrPermissionForbidden) Error() string

Error implementation for ErrPermissionForbidden.

type ErrUninitialized

type ErrUninitialized struct{}

ErrUninitialized is raised when grpc service serve after wrong/no dial.

func (ErrUninitialized) Error

func (err ErrUninitialized) Error() string

Error implementation for ErrUninitialized.

type Service

type Service struct {
	Register func()

	*grpc.Server
	// contains filtered or unexported fields
}

Service embed a grpc server.

func (*Service) Close

func (s *Service) Close(ctx context.Context) error

func (*Service) Dial

func (s *Service) Dial(ctx context.Context, cfg Config) error

Dial connects grpc server and call Register method.

func (*Service) Serve

func (s *Service) Serve(ctx context.Context) error