rpc

Documentation

Index

• Variables
• type Option
  • func WithLogger(logger *echelon.Logger) Option
• type RPC
  • func New(build *build.Build, opts ...Option) *RPC
  • func (r *RPC) CacheInfo(ctx context.Context, req *api.CacheInfoRequest) (*api.CacheInfoResponse, error)
  • func (r *RPC) ClientSecret() string
  • func (r *RPC) ContainerEndpoint() string
  • func (r *RPC) DirectEndpoint() string
  • func (r *RPC) DownloadCache(req *api.DownloadCacheRequest, stream api.CirrusCIService_DownloadCacheServer) error
  • func (r *RPC) Heartbeat(ctx context.Context, req *api.HeartbeatRequest) (*api.HeartbeatResponse, error)
  • func (r *RPC) InitialCommands(ctx context.Context, req *api.InitialCommandsRequest) (*api.CommandsResponse, error)
  • func (r *RPC) ReportAgentError(ctx context.Context, req *api.ReportAgentProblemRequest) (*empty.Empty, error)
  • func (r *RPC) ReportAgentLogs(ctx context.Context, req *api.ReportAgentLogsRequest) (*empty.Empty, error)
  • func (r *RPC) ReportAgentSignal(ctx context.Context, req *api.ReportAgentSignalRequest) (*empty.Empty, error)
  • func (r *RPC) ReportAgentWarning(ctx context.Context, req *api.ReportAgentProblemRequest) (*empty.Empty, error)
  • func (r *RPC) ReportAnnotations(ctx context.Context, req *api.ReportAnnotationsCommandRequest) (*empty.Empty, error)
  • func (r *RPC) ReportSingleCommand(ctx context.Context, req *api.ReportSingleCommandRequest) (*api.ReportSingleCommandResponse, error)
  • func (r *RPC) SaveLogs(stream api.CirrusCIService_SaveLogsServer) error
  • func (r *RPC) ServerSecret() string
  • func (r *RPC) Start(ctx context.Context, address string) error
  • func (r *RPC) Stop()
  • func (r *RPC) StreamLogs(stream api.CirrusCIService_StreamLogsServer) error
  • func (r *RPC) UploadArtifacts(stream api.CirrusCIService_UploadArtifactsServer) error
  • func (r *RPC) UploadCache(stream api.CirrusCIService_UploadCacheServer) error

Variables

var ErrRPCFailed = errors.New("RPC server failed")

Types

type Option

type Option func(*RPC)

func WithLogger

func WithLogger(logger *echelon.Logger) Option

type RPC

type RPC struct {
	// must be embedded to have forward compatible implementations
	api.UnimplementedCirrusCIServiceServer
	// contains filtered or unexported fields
}

func New

func New(build *build.Build, opts ...Option) *RPC

func (*RPC) CacheInfo

func (r *RPC) CacheInfo(ctx context.Context, req *api.CacheInfoRequest) (*api.CacheInfoResponse, error)

func (*RPC) ClientSecret

func (r *RPC) ClientSecret() string

func (*RPC) ContainerEndpoint

func (r *RPC) ContainerEndpoint() string

ContainerEndpoint returns RPC server address suitable for use in agent's "-api-endpoint" flag when running inside of a container.

func (*RPC) DirectEndpoint

func (r *RPC) DirectEndpoint() string

DirectEndpoint returns RPC server address suitable for use in agent's "-api-endpoint" flag when running on the host.

func (*RPC) DownloadCache

func (r *RPC) DownloadCache(req *api.DownloadCacheRequest, stream api.CirrusCIService_DownloadCacheServer) error

func (*RPC) Heartbeat

func (r *RPC) Heartbeat(ctx context.Context, req *api.HeartbeatRequest) (*api.HeartbeatResponse, error)

func (*RPC) InitialCommands

func (r *RPC) InitialCommands(
	ctx context.Context,
	req *api.InitialCommandsRequest,
) (*api.CommandsResponse, error)

func (*RPC) ReportAgentError

func (r *RPC) ReportAgentError(ctx context.Context, req *api.ReportAgentProblemRequest) (*empty.Empty, error)

func (*RPC) ReportAgentLogs

func (r *RPC) ReportAgentLogs(ctx context.Context, req *api.ReportAgentLogsRequest) (*empty.Empty, error)

func (*RPC) ReportAgentSignal

func (r *RPC) ReportAgentSignal(ctx context.Context, req *api.ReportAgentSignalRequest) (*empty.Empty, error)

func (*RPC) ReportAgentWarning

func (r *RPC) ReportAgentWarning(ctx context.Context, req *api.ReportAgentProblemRequest) (*empty.Empty, error)

func (*RPC) ReportAnnotations

func (r *RPC) ReportAnnotations(ctx context.Context, req *api.ReportAnnotationsCommandRequest) (*empty.Empty, error)

func (*RPC) ReportSingleCommand

func (r *RPC) ReportSingleCommand(
	ctx context.Context,
	req *api.ReportSingleCommandRequest,
) (*api.ReportSingleCommandResponse, error)

func (*RPC) SaveLogs

func (r *RPC) SaveLogs(stream api.CirrusCIService_SaveLogsServer) error

func (*RPC) ServerSecret

func (r *RPC) ServerSecret() string

func (*RPC) Start

func (r *RPC) Start(ctx context.Context, address string) error

Start creates the listener and starts RPC server in a separate goroutine.

func (*RPC) Stop

func (r *RPC) Stop()

Stop gracefully stops the RPC server.

func (*RPC) StreamLogs

func (r *RPC) StreamLogs(stream api.CirrusCIService_StreamLogsServer) error

func (*RPC) UploadArtifacts

func (r *RPC) UploadArtifacts(stream api.CirrusCIService_UploadArtifactsServer) error

func (*RPC) UploadCache

func (r *RPC) UploadCache(stream api.CirrusCIService_UploadCacheServer) error