search

Documentation

Overview

Package search defines a service to search for nodes from a partial VName and collection of facts.

Index

• func RegisterHTTPHandlers(ctx context.Context, s Service, mux *http.ServeMux)
• type Service
  • func GRPC(c spb.SearchServiceClient) Service
  • func WebClient(addr string) Service

Functions

func RegisterHTTPHandlers

func RegisterHTTPHandlers(ctx context.Context, s Service, mux *http.ServeMux)

RegisterHTTPHandlers registers JSON HTTP handlers with mux using the given search Service. The following method with be exposed:

GET /search
  Request: JSON encoded storage.SearchRequest
  Response: JSON encoded storage.SearchReply

Note: /search will return its response as serialized protobuf if the "proto" query parameter is set.

Types

type Service

type Service interface {
	// Search returns the matching set of nodes that match the given request.
	Search(context.Context, *spb.SearchRequest) (*spb.SearchReply, error)
}

Service to search for nodes based on a partial VName and collection of known facts.

func GRPC

func GRPC(c spb.SearchServiceClient) Service

GRPC returns a search Service backed by the given GRPC client and context.

func WebClient

func WebClient(addr string) Service

WebClient returns a search Service based on a remote web server.