modules.go

/*
Copyright IBM Corp. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0
*/

// Package modules provides interfaces of modules that serve as building blocks of a Node.
// Implementations of those interfaces are not contained by this package
// and are expected to be provided by other packages.
package modules

import (
	"context"

	t "github.com/filecoin-project/mir/pkg/types"
)

// Module generalizes the ActiveModule and PassiveModule types.
type Module interface {

	// ImplementsModule only serves the purpose of indicating that this is a Module and must not be called.
	ImplementsModule()
}

// The Modules structs groups the modules a Node consists of.
type Modules map[t.ModuleID]Module

// ConvertConcurrentEventAppliersToGoroutinePools modifies the module set, turning ConcurrentEventApplier modules into
// GoroutinePool modules, using the given context and worker count.
// Returns the (modified) module set.
func (mods Modules) ConvertConcurrentEventAppliersToGoroutinePools(ctx context.Context, nWorkers int) Modules {
	for name, mod := range mods {
		if oldMod, ok := mod.(ConcurrentEventApplierModule); ok {
			mods[name] = oldMod.IntoGoroutinePool(ctx, nWorkers)
		}
	}

	return mods
}