analysis_service_proto

Documentation

Overview

Package analysis_service_proto is a generated protocol buffer package.

It is generated from these files:

kythe/proto/analysis_service.proto

It has these top-level messages:

Index

• func RegisterCompilationAnalyzerServer(s *grpc.Server, srv CompilationAnalyzerServer)
• func RegisterFileDataServiceServer(s *grpc.Server, srv FileDataServiceServer)
• type CompilationAnalyzerClient
  • func NewCompilationAnalyzerClient(cc *grpc.ClientConn) CompilationAnalyzerClient
• type CompilationAnalyzerServer
• type CompilationAnalyzer_AnalyzeClient
• type CompilationAnalyzer_AnalyzeServer
• type FileDataServiceClient
  • func NewFileDataServiceClient(cc *grpc.ClientConn) FileDataServiceClient
• type FileDataServiceServer
• type FileDataService_GetClient
• type FileDataService_GetServer

Functions

func RegisterCompilationAnalyzerServer

func RegisterCompilationAnalyzerServer(s *grpc.Server, srv CompilationAnalyzerServer)

func RegisterFileDataServiceServer

func RegisterFileDataServiceServer(s *grpc.Server, srv FileDataServiceServer)

Types

type CompilationAnalyzerClient

type CompilationAnalyzerClient interface {
	// Analyze is the main entry point for the analysis driver to send work to the
	// analyzer.  The analysis may produce many outputs which will be streamed as
	// framed AnalysisOutput messages.
	//
	// A driver may choose to retry analyses that return RPC errors.  It should
	// not retry analyses that are reported as finished unless it is necessary to
	// recover from an external production issue.
	Analyze(ctx context.Context, in *kythe_proto2.AnalysisRequest, opts ...grpc.CallOption) (CompilationAnalyzer_AnalyzeClient, error)
}

func NewCompilationAnalyzerClient

func NewCompilationAnalyzerClient(cc *grpc.ClientConn) CompilationAnalyzerClient

type CompilationAnalyzerServer

type CompilationAnalyzerServer interface {
	// Analyze is the main entry point for the analysis driver to send work to the
	// analyzer.  The analysis may produce many outputs which will be streamed as
	// framed AnalysisOutput messages.
	//
	// A driver may choose to retry analyses that return RPC errors.  It should
	// not retry analyses that are reported as finished unless it is necessary to
	// recover from an external production issue.
	Analyze(*kythe_proto2.AnalysisRequest, CompilationAnalyzer_AnalyzeServer) error
}

type CompilationAnalyzer_AnalyzeClient

type CompilationAnalyzer_AnalyzeClient interface {
	Recv() (*kythe_proto2.AnalysisOutput, error)
	grpc.ClientStream
}

type CompilationAnalyzer_AnalyzeServer

type CompilationAnalyzer_AnalyzeServer interface {
	Send(*kythe_proto2.AnalysisOutput) error
	grpc.ServerStream
}

type FileDataServiceClient

type FileDataServiceClient interface {
	// Get returns the contents of one or more files needed for analysis.  It is
	// the server's responsibility to do any caching necessary to make this
	// perform well, so that an analyzer does not need to implement its own
	// caches unless it is doing something unusual.
	//
	// For each distinct path/digest pair in the request, the server must return
	// exactly one response.  The order of the responses is arbitrary.
	//
	// For each requested file, one or both of the path and digest fields must be
	// nonempty, otherwise an error is returned.  It is not an error for there to
	// be no requested files, however.
	Get(ctx context.Context, in *kythe_proto2.FilesRequest, opts ...grpc.CallOption) (FileDataService_GetClient, error)
}

func NewFileDataServiceClient

func NewFileDataServiceClient(cc *grpc.ClientConn) FileDataServiceClient

type FileDataServiceServer

type FileDataServiceServer interface {
	// Get returns the contents of one or more files needed for analysis.  It is
	// the server's responsibility to do any caching necessary to make this
	// perform well, so that an analyzer does not need to implement its own
	// caches unless it is doing something unusual.
	//
	// For each distinct path/digest pair in the request, the server must return
	// exactly one response.  The order of the responses is arbitrary.
	//
	// For each requested file, one or both of the path and digest fields must be
	// nonempty, otherwise an error is returned.  It is not an error for there to
	// be no requested files, however.
	Get(*kythe_proto2.FilesRequest, FileDataService_GetServer) error
}

type FileDataService_GetClient

type FileDataService_GetClient interface {
	Recv() (*kythe_proto2.FileData, error)
	grpc.ClientStream
}

type FileDataService_GetServer

type FileDataService_GetServer interface {
	Send(*kythe_proto2.FileData) error
	grpc.ServerStream
}