httprest

Documentation

Index

• func CreateRESTHandler(s pb.VerifiableDataStructuresServiceServer, cc ContextCreator, ...) http.Handler
• func StartServer(conf *pb.ServerConfig, server pb.VerifiableDataStructuresServiceServer) error
• type Client
  • func (c *Client) Dial() (pb.VerifiableDataStructuresServiceServer, error)
  • func (c *Client) MustDial() pb.VerifiableDataStructuresServiceServer
• type ContextCreator

Functions

func CreateRESTHandler

func CreateRESTHandler(s pb.VerifiableDataStructuresServiceServer, cc ContextCreator, logger *log.Logger) http.Handler

CreateRESTHandler creates handlers for the API Leave cc nil unless you need to be able to create a specialized context, e.g. GAE logger can be nil - set for debug

func StartServer

func StartServer(conf *pb.ServerConfig, server pb.VerifiableDataStructuresServiceServer) error

StartServer starts an HTTP REST server given a service. Normally this service is an instance of LocalService.

Types

type Client

type Client struct {
	// BaseURL is the URL (with no trailing slash) of the server, e.g. http://localhost:8081
	BaseURL string

	// HTTPClient is the client to use for sending requests.
	HTTPClient *http.Client
}

Client provides a way to access the API over HTTP REST. Where possible it is suggested that the grpc.Client be used in preference.

func (*Client) Dial

func (c *Client) Dial() (pb.VerifiableDataStructuresServiceServer, error)

Dial returns a server object read to speak with directly or wrap.

func (*Client) MustDial

func (c *Client) MustDial() pb.VerifiableDataStructuresServiceServer

MustDial is a convenience method that exits with a fatal error if the operation fails

type ContextCreator

type ContextCreator func(*http.Request) context.Context

ContextCreator is a function that can produce a context object based on a request. If not specified, a background context will be used.