explore

Documentation

Overview

Package explore defines the ExploreService interface.

Index

• type BoundedRequests
• type Service

Types

type BoundedRequests

type BoundedRequests struct {
	MaxTickets int
	Service
}

BoundedRequests guards against requests that include so many input tickets that they threaten the functioning of the service (in the absence of server-side throttling of individual requests).

type Service

type Service interface {
	// Returns the hierarchy (supertypes and subtypes, including implementations)
	// of a specified type, as a directed acyclic graph.
	// NOT YET IMPLEMENTED
	TypeHierarchy(context.Context, *epb.TypeHierarchyRequest) (*epb.TypeHierarchyReply, error)

	// Returns the (recursive) callers of a specified function, as a directed
	// graph.
	// The Callers/Callees functions are distinct from XrefService.CrossReferences
	// in that these functions capture the semantic relationships between methods,
	// rather than the locations in the code base where a method is called.
	// NOT YET IMPLEMENTED
	Callers(context.Context, *epb.CallersRequest) (*epb.CallersReply, error)

	// Returns the (recursive) callees of a specified function (that is, what
	// functions this function calls), as a directed graph.
	// NOT YET IMPLEMENTED
	Callees(context.Context, *epb.CalleesRequest) (*epb.CalleesReply, error)

	// Returns the parameters of a specified function.
	// NOT YET IMPLEMENTED
	Parameters(context.Context, *epb.ParametersRequest) (*epb.ParametersReply, error)

	// Returns the parents of a specified node
	// (for example, the file for a class, or the class for a function).
	// Note that in some cases a node may have more than one parent.
	Parents(context.Context, *epb.ParentsRequest) (*epb.ParentsReply, error)

	// Returns the children of a specified node
	// (for example, the classes contained in a file, or the functions contained in a class).
	Children(context.Context, *epb.ChildrenRequest) (*epb.ChildrenReply, error)
}

Service defines the interface for the ExploreService defined in kythe/proto/explore.proto.