rpc

Documentation

Index

• Constants
• func GetCustomWebhookEndpointFromContext(ctx context.Context) string
• func GetTrackingIDFromContext(ctx context.Context) string
• func GetURIFromContext(ctx context.Context) string
• func NewProxy(opts ...ProxyOption) *proxy
• type API
• type Middleware
• type Proxy
• type ProxyOption
  • func AllowCORS(origins []string) ProxyOption
  • func HTTPServer(s *http.Server) ProxyOption
  • func HttpMetrics(opts ...metrics.Option) ProxyOption
  • func Middlewares(mws ...Middleware) ProxyOption
  • func Proxies(proxies ...Proxy) ProxyOption
• type Server
  • func NewServer(opts ...ServerOption) *Server
  • func (s *Server) Serve(l net.Listener) error
  • func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (s *Server) Shutdown()
• type ServerOption
  • func APIs(apis ...API) ServerOption
  • func Credentials(credentials *tls.Config) ServerOption
  • func Metrics(metrics metrics.ServerMetrics) ServerOption
  • func SeverOptions(opts ...grpc.ServerOption) ServerOption
  • func StreamInterceptors(interceptors ...grpc.StreamServerInterceptor) ServerOption
  • func UnaryInterceptors(interceptors ...grpc.UnaryServerInterceptor) ServerOption

Constants

const (
	MetadataKeyTrackingID         string = "tracking-id"
	MetadataKeyURI                string = "uri"
	MetadataCustomWebhookEndpoint string = "custom-webhook-endpoint"
)

Keys used for retrieving value from gRPC metadata

Functions

func GetCustomWebhookEndpointFromContext

func GetCustomWebhookEndpointFromContext(ctx context.Context) string

func GetTrackingIDFromContext

func GetTrackingIDFromContext(ctx context.Context) string

func GetURIFromContext

func GetURIFromContext(ctx context.Context) string

func NewProxy

func NewProxy(opts ...ProxyOption) *proxy

NewProxy creates a RESTful proxy server that routes RESTful request to gRPC server

Types

type API

type API interface {
	Bind(server *grpc.Server)
}

API provides APIs for specific gRPC server

type Middleware

type Middleware interface {
	ServeHTTP(w http.ResponseWriter, req *http.Request, next http.HandlerFunc)
}

type Proxy

type Proxy interface {
	Bind(mux *runtime.ServeMux) error
}

Proxy provides APIs for specific gRPC server

type ProxyOption

type ProxyOption func(*proxy)

func AllowCORS

func AllowCORS(origins []string) ProxyOption

AllowCORS represents the CORS origins to setup for RESTful API

func HTTPServer

func HTTPServer(s *http.Server) ProxyOption

HTTPServer represents customized HTTP server to the proxy

func HttpMetrics

func HttpMetrics(opts ...metrics.Option) ProxyOption

func Middlewares

func Middlewares(mws ...Middleware) ProxyOption

Middlewares represents the HTTP middlwares to be used in this proxy

func Proxies

func Proxies(proxies ...Proxy) ProxyOption

Proxies represents the proxy API to be registered to the http server

type Server

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

Server represents a gRPC server

func NewServer

func NewServer(opts ...ServerOption) *Server

NewServer creates a gRPC server with pre-configured services

func (*Server) Serve

func (s *Server) Serve(l net.Listener) error

func (*Server) ServeHTTP

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Server) Shutdown

func (s *Server) Shutdown()

type ServerOption

type ServerOption func(*Server)

func APIs

func APIs(apis ...API) ServerOption

APIs to be registered to the RPC server

func Credentials

func Credentials(credentials *tls.Config) ServerOption

Credentials for the RPC server

func Metrics

func Metrics(metrics metrics.ServerMetrics) ServerOption

func SeverOptions

func SeverOptions(opts ...grpc.ServerOption) ServerOption

SeverOptions passes additional gRPC server options

func StreamInterceptors

func StreamInterceptors(interceptors ...grpc.StreamServerInterceptor) ServerOption

func UnaryInterceptors

func UnaryInterceptors(interceptors ...grpc.UnaryServerInterceptor) ServerOption