bbs

type Client interface {
	ExternalClient

	ClaimActualLRP(processGuid string, index int, instanceKey *models.ActualLRPInstanceKey) error
	StartActualLRP(key *models.ActualLRPKey, instanceKey *models.ActualLRPInstanceKey, netInfo *models.ActualLRPNetInfo) error
	CrashActualLRP(key *models.ActualLRPKey, instanceKey *models.ActualLRPInstanceKey, errorMessage string) error
	FailActualLRP(key *models.ActualLRPKey, errorMessage string) error
	RemoveActualLRP(processGuid string, index int) error

	EvacuateClaimedActualLRP(*models.ActualLRPKey, *models.ActualLRPInstanceKey) (bool, error)
	EvacuateRunningActualLRP(*models.ActualLRPKey, *models.ActualLRPInstanceKey, *models.ActualLRPNetInfo, uint64) (bool, error)
	EvacuateStoppedActualLRP(*models.ActualLRPKey, *models.ActualLRPInstanceKey) (bool, error)
	EvacuateCrashedActualLRP(*models.ActualLRPKey, *models.ActualLRPInstanceKey, string) (bool, error)
	RemoveEvacuatingActualLRP(*models.ActualLRPKey, *models.ActualLRPInstanceKey) error

	ConvergeLRPs() error

	ConvergeTasks(kickTaskDuration, expirePendingTaskDuration, expireCompletedTaskDuration time.Duration) error
	StartTask(taskGuid string, cellID string) (bool, error)
	FailTask(taskGuid, failureReason string) error
	CompleteTask(taskGuid, cellId string, failed bool, failureReason, result string) error
	ResolvingTask(taskGuid string) error
	DeleteTask(taskGuid string) error

	SubscribeToEvents() (events.EventSource, error)
}

type ExternalActualLRPClient interface {
	// Returns all ActualLRPGroups matching the given ActualLRPFilter
	ActualLRPGroups(models.ActualLRPFilter) ([]*models.ActualLRPGroup, error)

	// Returns all ActualLRPGroups that have the given process guid
	ActualLRPGroupsByProcessGuid(processGuid string) ([]*models.ActualLRPGroup, error)

	// Returns the ActualLRPGroup with the given process guid and instance index
	ActualLRPGroupByProcessGuidAndIndex(processGuid string, index int) (*models.ActualLRPGroup, error)

	// Shuts down the ActualLRP matching the given ActualLRPKey, but does not modify the desired state
	RetireActualLRP(key *models.ActualLRPKey) error
}

type ExternalClient interface {
	ExternalTaskClient
	ExternalDomainClient
	ExternalActualLRPClient
	ExternalDesiredLRPClient
	ExternalEventClient

	// Returns true if the BBS server is reachable
	Ping() bool

	// Lists all Cells
	Cells() ([]*models.CellPresence, error)
}

type ExternalDesiredLRPClient interface {
	// Lists all DesiredLRPs that match the given DesiredLRPFilter
	DesiredLRPs(models.DesiredLRPFilter) ([]*models.DesiredLRP, error)

	// Returns the DesiredLRP with the given process guid
	DesiredLRPByProcessGuid(processGuid string) (*models.DesiredLRP, error)

	// Returns all DesiredLRPSchedulingInfos that match the given DesiredLRPFilter
	DesiredLRPSchedulingInfos(models.DesiredLRPFilter) ([]*models.DesiredLRPSchedulingInfo, error)

	// Creates the given DesiredLRP and its corresponding ActualLRPs
	DesireLRP(*models.DesiredLRP) error

	// Updates the DesiredLRP matching the given process guid
	UpdateDesiredLRP(processGuid string, update *models.DesiredLRPUpdate) error

	// Removes the DesiredLRP matching the given process guid
	RemoveDesiredLRP(processGuid string) error
}

type ExternalDomainClient interface {
	// Lists the active domains
	Domains() ([]string, error)

	// Creates a domain or bumps the ttl on an existing domain
	UpsertDomain(domain string, ttl time.Duration) error
}

type ExternalEventClient interface {
	// Returns an EventSource for watching changes to DesiredLRPs
	SubscribeToDesiredLRPEvents() (events.EventSource, error)

	// Returns an EventSource for watching changes to ActualLRPs
	SubscribeToActualLRPEvents() (events.EventSource, error)

	// Returns an EventSource for watching changes to Tasks
	SubscribeToTaskEvents() (events.EventSource, error)
}

type ExternalTaskClient interface {
	// Creates a Task from the given TaskDefinition
	DesireTask(guid, domain string, def *models.TaskDefinition) error

	// Lists all Tasks
	Tasks() ([]*models.Task, error)

	// Lists all Tasks of the given domain
	TasksByDomain(domain string) ([]*models.Task, error)

	// Lists all Tasks on the given cell
	TasksByCellID(cellId string) ([]*models.Task, error)

	// Returns the Task with the given guid
	TaskByGuid(guid string) (*models.Task, error)

	// Cancels the Task with the given task guid
	CancelTask(taskGuid string) error
}

type ServiceClient interface {
	CellById(logger lager.Logger, cellId string) (*models.CellPresence, error)
	Cells(logger lager.Logger) (models.CellSet, error)
	CellEvents(logger lager.Logger) <-chan models.CellEvent
	NewCellPresenceRunner(logger lager.Logger, cellPresence *models.CellPresence, retryInterval, lockTTL time.Duration) ifrit.Runner
	NewBBSLockRunner(logger lager.Logger, bbsPresence *models.BBSPresence, retryInterval, lockTTL time.Duration) (ifrit.Runner, error)
	CurrentBBS(logger lager.Logger) (*models.BBSPresence, error)
	CurrentBBSURL(logger lager.Logger) (string, error)
}