admin

Documentation

Index

• type Client
  • func NewClient(log *logging.Logger, config Config) *Client
  • func (s *Client) CopyHistorySegmentToFile(ctx context.Context, historySegmentID string, filePath string) (CopyHistorySegmentToFileReply, error)
  • func (s *Client) FetchNetworkHistorySegment(ctx context.Context, historySegmentID string) (store.SegmentIndexEntry, error)
• type Config
  • func NewDefaultConfig() Config
• type CopyHistorySegmentToFileArg
• type CopyHistorySegmentToFileReply
• type NetworkHistoryAdminService
  • func NewNetworkHistoryAdminService(networkHistoryService NetworkHistoryService) *NetworkHistoryAdminService
  • func (d *NetworkHistoryAdminService) CopyHistorySegmentToFile(req *http.Request, args *CopyHistorySegmentToFileArg, ...) error
  • func (d *NetworkHistoryAdminService) FetchHistorySegment(req *http.Request, historySegmentID *string, reply *networkhistory.Segment) (err error)
• type NetworkHistoryService
• type Server
  • func NewServer(log *logging.Logger, config Config, zetaPaths paths.Paths, ...) *Server
  • func (s *Server) ReloadConf(cfg Config)
  • func (s *Server) Start(ctx context.Context) error
  • func (s *Server) Stop()
• type ServerConfig

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(
	log *logging.Logger,
	config Config,
) *Client

func (*Client) CopyHistorySegmentToFile

func (s *Client) CopyHistorySegmentToFile(ctx context.Context, historySegmentID string, filePath string) (CopyHistorySegmentToFileReply, error)

func (*Client) FetchNetworkHistorySegment

func (s *Client) FetchNetworkHistorySegment(ctx context.Context, historySegmentID string) (store.SegmentIndexEntry, error)

type Config

type Config struct {
	Level  encoding.LogLevel `long:"log-level"`
	Server ServerConfig      `group:"Server" namespace:"server"`
}

Config represents the configuration of the admin package.

func NewDefaultConfig

func NewDefaultConfig() Config

NewDefaultConfig creates an instance of the package specific configuration.

type CopyHistorySegmentToFileArg

type CopyHistorySegmentToFileArg struct {
	HistorySegmentID string
	OutFile          string
}

type CopyHistorySegmentToFileReply

type CopyHistorySegmentToFileReply struct {
	Reply string
	Err   error
}

type NetworkHistoryAdminService

type NetworkHistoryAdminService struct {
	// contains filtered or unexported fields
}

func NewNetworkHistoryAdminService

func NewNetworkHistoryAdminService(networkHistoryService NetworkHistoryService) *NetworkHistoryAdminService

func (*NetworkHistoryAdminService) CopyHistorySegmentToFile

func (d *NetworkHistoryAdminService) CopyHistorySegmentToFile(req *http.Request, args *CopyHistorySegmentToFileArg, reply *CopyHistorySegmentToFileReply) error

func (*NetworkHistoryAdminService) FetchHistorySegment

func (d *NetworkHistoryAdminService) FetchHistorySegment(req *http.Request, historySegmentID *string, reply *networkhistory.Segment) (err error)

type NetworkHistoryService

type NetworkHistoryService interface {
	CopyHistorySegmentToFile(ctx context.Context, historySegmentID string, outFile string) error
	FetchHistorySegment(ctx context.Context, historySegmentID string) (networkhistory.Segment, error)
}

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer(log *logging.Logger, config Config, zetaPaths paths.Paths, service *NetworkHistoryAdminService) *Server

func (*Server) ReloadConf

func (s *Server) ReloadConf(cfg Config)

ReloadConf update the internal configuration of the server.

func (*Server) Start

func (s *Server) Start(ctx context.Context) error

Start starts the RPC based API server.

func (*Server) Stop

func (s *Server) Stop()

Stop stops the RPC based API server.

type ServerConfig

type ServerConfig struct {
	SocketPath string `long:"socket-path" description:"Listen for connection on UNIX socket path <file-path>"`
	HTTPPath   string `long:"http-path" description:"Http path of the socket HTTP RPC server"`
}

ServerConfig contains the configuration for the admin server.