archive

Documentation

Overview

Package archive defines the RPC interface for archiving benchmark results.

Index

• Variables
• type BenchmarkArchiverClientMethods
• type BenchmarkArchiverClientStub
  • func BenchmarkArchiverClient(name string) BenchmarkArchiverClientStub
• type BenchmarkArchiverServerMethods
• type BenchmarkArchiverServerStub
  • func BenchmarkArchiverServer(impl BenchmarkArchiverServerMethods) BenchmarkArchiverServerStub
• type BenchmarkArchiverServerStubMethods

Variables

var BenchmarkArchiverDesc rpc.InterfaceDesc = descBenchmarkArchiver

BenchmarkArchiverDesc describes the BenchmarkArchiver interface.

Types

type BenchmarkArchiverClientMethods

type BenchmarkArchiverClientMethods interface {
	// Archive saves results in 'runs' under the assumption that the
	// benchmarks were run on a machine whose configuration is defined by
	// 'scenario' and the were built from source code described by 'code'
	// (a commit hash of a repository, the manifest of a jiri project etc.)
	//
	// Returns a URL that can be used to browse the uploaded benchmark
	// results.
	Archive(_ *context.T, scenario ben.Scenario, code ben.SourceCode, runs []ben.Run, _ ...rpc.CallOpt) (string, error)
}

BenchmarkArchiverClientMethods is the client interface containing BenchmarkArchiver methods.

BenchmarkArchiver is the interface to store microbenchmark results.

type BenchmarkArchiverClientStub

type BenchmarkArchiverClientStub interface {
	BenchmarkArchiverClientMethods
	rpc.UniversalServiceMethods
}

BenchmarkArchiverClientStub adds universal methods to BenchmarkArchiverClientMethods.

func BenchmarkArchiverClient

func BenchmarkArchiverClient(name string) BenchmarkArchiverClientStub

BenchmarkArchiverClient returns a client stub for BenchmarkArchiver.

type BenchmarkArchiverServerMethods

type BenchmarkArchiverServerMethods interface {
	// Archive saves results in 'runs' under the assumption that the
	// benchmarks were run on a machine whose configuration is defined by
	// 'scenario' and the were built from source code described by 'code'
	// (a commit hash of a repository, the manifest of a jiri project etc.)
	//
	// Returns a URL that can be used to browse the uploaded benchmark
	// results.
	Archive(_ *context.T, _ rpc.ServerCall, scenario ben.Scenario, code ben.SourceCode, runs []ben.Run) (string, error)
}

BenchmarkArchiverServerMethods is the interface a server writer implements for BenchmarkArchiver.

BenchmarkArchiver is the interface to store microbenchmark results.

type BenchmarkArchiverServerStub

type BenchmarkArchiverServerStub interface {
	BenchmarkArchiverServerStubMethods
	// Describe the BenchmarkArchiver interfaces.
	Describe__() []rpc.InterfaceDesc
}

BenchmarkArchiverServerStub adds universal methods to BenchmarkArchiverServerStubMethods.

func BenchmarkArchiverServer

func BenchmarkArchiverServer(impl BenchmarkArchiverServerMethods) BenchmarkArchiverServerStub

BenchmarkArchiverServer returns a server stub for BenchmarkArchiver. It converts an implementation of BenchmarkArchiverServerMethods into an object that may be used by rpc.Server.

type BenchmarkArchiverServerStubMethods

type BenchmarkArchiverServerStubMethods BenchmarkArchiverServerMethods

BenchmarkArchiverServerStubMethods is the server interface containing BenchmarkArchiver methods, as expected by rpc.Server. There is no difference between this interface and BenchmarkArchiverServerMethods since there are no streaming methods.