external

type Caravela interface {

	// Sends a create offer message to a trader from a supplier that wants to offer its resources.
	CreateOffer(ctx context.Context, fromNode, toNode *types.Node, offer *types.Offer) error

	// Sends a refresh message from a trader to a supplier. It is used to mutually know that both are alive.
	RefreshOffer(ctx context.Context, fromTrader, toSupp *types.Node, offer *types.Offer) (bool, error)

	// Sends a remove offer message from a supplier to a trader. It means the supplier does not handle the offer anymore.
	RemoveOffer(ctx context.Context, fromSupp, toTrader *types.Node, offer *types.Offer) error

	// Sends a get message to obtain all the available offers in a trader.
	GetOffers(ctx context.Context, fromNode, toTrader *types.Node, relay bool) ([]types.AvailableOffer, error)

	// Sends a message to a neighbor trader saying that a given trader has offers available
	AdvertiseOffersNeighbor(ctx context.Context, fromTrader, toNeighborTrader, traderOffering *types.Node) error

	// Sends a launch container message to a supplier in order to deploy the container
	LaunchContainer(ctx context.Context, fromBuyer, toSupplier *types.Node, offer *types.Offer,
		containerConfig []types.ContainerConfig) ([]types.ContainerStatus, error)

	// Sends a stop container message to a supplier in order to stop the container
	StopLocalContainer(ctx context.Context, toSupplier *types.Node, containerID string) error

	// Sends a message to obtain the system configurations of an existing node. Used by joining nodes to know what are
	// the system configuration parameters and the respective values.
	ObtainConfiguration(ctx context.Context, systemsNode *types.Node) (*configuration.Configuration, error)
}

type DockerClient interface {
	// Obtains the Docker engine max CPU cores and RAM.
	GetDockerCPUAndRAM() (int, int)

	// Checks the status of a container in the  Docker engine.
	CheckContainerStatus(containerID string) (container.ContainerStatus, error)

	// Runs a container in the Docker engine.
	RunContainer(contConfig types.ContainerConfig) (*types.ContainerStatus, error)

	// Remove a container from the Docker engine.
	RemoveContainer(containerID string) error
}

type Overlay interface {
	// Create/Bootstrap the overlay in the current node.
	Create(ctx context.Context, thisNode types.OverlayMembership) error

	// Join an overlay given a participant node IP and the respective port where its overlay daemon is listening.
	Join(ctx context.Context, overlayNodeIP string, overlayNodePort int, thisNode types.OverlayMembership) error

	// Get a list of remote nodes using a given key.
	Lookup(ctx context.Context, key []byte) ([]*types.OverlayNode, error)

	// Get a list of the neighbors nodes of the given node.
	Neighbors(ctx context.Context, nodeID []byte) ([]*types.OverlayNode, error)

	// Unique identifier for the physical node where the overlay is running.
	// The overlay can have virtual nodes here we only want return always one ID that is unique in all nodes.
	NodeID(ctx context.Context) ([]byte, error)

	// Leave the overlay.
	Leave(ctx context.Context) error
}