cerpc

Documentation

Overview

Package cerpc handles RPCs over HTTP.

Index

• Variables
• func AddHeader(ctx context.Context, key, value string) bool
• func AttachRequest(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context
• func DefaultErrorHandler(w http.ResponseWriter, httpCode int, grpcCode codes.Code, msg string)
• func GetCookie(ctx context.Context, key string) (*http.Cookie, error)
• func GetHeader(ctx context.Context, key string) string
• func GetRequest(ctx context.Context) *http.Request
• func InternalDecodeRequest(w http.ResponseWriter, r *http.Request, inMsg proto.Message) bool
• func InternalDoClientRequest(ctx context.Context, url string, req, resp proto.Message, ...) error
• func InternalDoClientStream(ctx context.Context, urlString string, options []ClientOption) (grpc.ClientStream, error)
• func InternalHandleRequest(w http.ResponseWriter, r *http.Request, inMsg proto.Message, ...)
• func InternalRejectUnknownRPC(w http.ResponseWriter, name string)
• func InternalUpgrade(w http.ResponseWriter, r *http.Request, handler func(grpc.ServerStream) error)
• func WriteError(w http.ResponseWriter, err error)
• type ClientOption
  • func WithHTTPClient(h *http.Client) ClientOption
  • func WithHTTPHeaders(h http.Header) ClientOption
  • func WithWebsocketDialer(w websocket.Dialer) ClientOption
• type Service

Variables

var ErrorHandler = func(w http.ResponseWriter, httpCode int, grpcCode codes.Code, msg string) {
	log.Printf("Failed HTTP RPC: httpCode=%d, grpcCode=%s, msg=%q", httpCode, grpcCode.String(), msg)
	DefaultErrorHandler(w, httpCode, grpcCode, msg)
}

ErrorHandler is called whenever something went wrong, either in the cerpc framework or the receiving call. The ErrorHandler is responsible for responding to the HTTP request, and optionally logging.

Functions

func AddHeader

func AddHeader(ctx context.Context, key, value string) bool

AddHeader sets a header to be returned by the current cerpc HTTP request.

func AttachRequest

func AttachRequest(ctx context.Context, w http.ResponseWriter, r *http.Request) context.Context

AttachRequest creates a new context that has the given ResponseWriter and Request attached. It allows GetCookie and AddHeader on the returned context. Most users don't need this function because it's automatically attached when using the cerpc generated http handler.

func DefaultErrorHandler

func DefaultErrorHandler(w http.ResponseWriter, httpCode int, grpcCode codes.Code, msg string)

DefaultErrorHandler sends the given error back to the given ResponseWriter. The name is slightly misleading, because the actual default ErrorHandler adds a log.Printf call in addition to calling DefaultErrorHandler.

func GetCookie

func GetCookie(ctx context.Context, key string) (*http.Cookie, error)

GetCookie gets a cookie from the current request. The current request is determined from the context.

func GetHeader

func GetHeader(ctx context.Context, key string) string

GetHeader gets the first value of the header associated with key from the current request. The current request is determined from the context.

func GetRequest

func GetRequest(ctx context.Context) *http.Request

GetRequest gets the current request from the context.

func InternalDecodeRequest

func InternalDecodeRequest(w http.ResponseWriter, r *http.Request, inMsg proto.Message) bool

func InternalDoClientRequest

func InternalDoClientRequest(ctx context.Context, url string, req, resp proto.Message, options []ClientOption) error

func InternalDoClientStream

func InternalDoClientStream(ctx context.Context, urlString string, options []ClientOption) (grpc.ClientStream, error)

func InternalHandleRequest

func InternalHandleRequest(w http.ResponseWriter, r *http.Request, inMsg proto.Message, handler func(ctx context.Context) (proto.Message, error))

func InternalRejectUnknownRPC

func InternalRejectUnknownRPC(w http.ResponseWriter, name string)

func InternalUpgrade

func InternalUpgrade(w http.ResponseWriter, r *http.Request, handler func(grpc.ServerStream) error)

func WriteError

func WriteError(w http.ResponseWriter, err error)

Types

type ClientOption

type ClientOption func(*clientOptions)

ClientOption allows you to change the default settings of the generated New*CeRPCClient().

func WithHTTPClient

func WithHTTPClient(h *http.Client) ClientOption

WithHTTPClient lets the Client use this http.Client rather than http.DefaultClient.

func WithHTTPHeaders

func WithHTTPHeaders(h http.Header) ClientOption

WithHTTPHeaders lets the Client send these extra headers.

func WithWebsocketDialer

func WithWebsocketDialer(w websocket.Dialer) ClientOption

WithWebsocketDialer lets the Client use this websocket.Dialer rather than the default.

type Service

type Service interface {
	http.Handler
	Name() string
}