api

Documentation

Overview

Package api defines types and constants useful for the API between the daemon service and client.

Index

• Constants
• type AddCmdRequest
• type AddCmdResponse
• type AddDirRequest
• type AddDirResponse
• type CmdRequest
• type CmdResponse
• type CmdsRequest
• type CmdsResponse
• type CmdsWithSeqRequest
• type CmdsWithSeqResponse
• type DelCmdRequest
• type DelCmdResponse
• type DelDirRequest
• type DelDirResponse
• type DelSharedVarRequest
• type DelSharedVarResponse
• type DirsRequest
• type DirsResponse
• type NextCmdRequest
• type NextCmdResponse
• type NextCmdSeqRequest
• type NextCmdSeqResponse
• type PidRequest
• type PidResponse
• type PrevCmdRequest
• type PrevCmdResponse
• type SetSharedVarRequest
• type SetSharedVarResponse
• type SharedVarRequest
• type SharedVarResponse
• type VersionRequest
• type VersionResponse

Constants

const ServiceName = "Daemon"

ServiceName is the name of the RPC service exposed by the daemon.

Types

type AddCmdRequest

type AddCmdRequest struct {
	Text string
}

type AddCmdResponse

type AddCmdResponse struct {
	Seq int
}

type AddDirRequest

type AddDirRequest struct {
	Dir       string
	IncFactor float64
}

type AddDirResponse

type AddDirResponse struct{}

type CmdRequest

type CmdRequest struct {
	Seq int
}

type CmdResponse

type CmdResponse struct {
	Text string
}

type CmdsRequest

type CmdsRequest struct {
	From int
	Upto int
}

type CmdsResponse

type CmdsResponse struct {
	Cmds []string
}

type CmdsWithSeqRequest

type CmdsWithSeqRequest struct {
	From int
	Upto int
}

type CmdsWithSeqResponse

type CmdsWithSeqResponse struct {
	Cmds []store.Cmd
}

type DelCmdRequest

type DelCmdRequest struct {
	Seq int
}

type DelCmdResponse

type DelCmdResponse struct {
}

type DelDirRequest

type DelDirRequest struct {
	Dir string
}

type DelDirResponse

type DelDirResponse struct{}

type DelSharedVarRequest

type DelSharedVarRequest struct {
	Name string
}

type DelSharedVarResponse

type DelSharedVarResponse struct{}

type DirsRequest

type DirsRequest struct {
	Blacklist map[string]struct{}
}

type DirsResponse

type DirsResponse struct {
	Dirs []store.Dir
}

type NextCmdRequest

type NextCmdRequest struct {
	From   int
	Prefix string
}

type NextCmdResponse

type NextCmdResponse struct {
	Seq  int
	Text string
}

type NextCmdSeqRequest

type NextCmdSeqRequest struct{}

type NextCmdSeqResponse

type NextCmdSeqResponse struct {
	Seq int
}

type PidRequest

type PidRequest struct{}

type PidResponse

type PidResponse struct {
	Pid int
}

type PrevCmdRequest

type PrevCmdRequest struct {
	Upto   int
	Prefix string
}

type PrevCmdResponse

type PrevCmdResponse struct {
	Seq  int
	Text string
}

type SetSharedVarRequest

type SetSharedVarRequest struct {
	Name  string
	Value string
}

type SetSharedVarResponse

type SetSharedVarResponse struct{}

type SharedVarRequest

type SharedVarRequest struct {
	Name string
}

type SharedVarResponse

type SharedVarResponse struct {
	Value string
}

type VersionRequest

type VersionRequest struct{}

type VersionResponse

type VersionResponse struct {
	Version int
}