frostfs-node/pkg/core/storagegroup/storagegroup.go

package storagegroup

import (
	"context"

	"github.com/TrueCloudLab/frostfs-node/pkg/core/client"
	cid "github.com/TrueCloudLab/frostfs-sdk-go/container/id"
	"github.com/TrueCloudLab/frostfs-sdk-go/netmap"
	oid "github.com/TrueCloudLab/frostfs-sdk-go/object/id"
	"github.com/TrueCloudLab/frostfs-sdk-go/storagegroup"
)

// SearchSGPrm groups the parameters which are formed by Processor to search the storage group objects.
type SearchSGPrm struct {
	Context context.Context

	Container cid.ID

	NodeInfo client.NodeInfo
}

// SearchSGDst groups the target values which Processor expects from SG searching to process.
type SearchSGDst struct {
	Objects []oid.ID
}

// GetSGPrm groups parameter of GetSG operation.
type GetSGPrm struct {
	Context context.Context

	OID oid.ID
	CID cid.ID

	NetMap    netmap.NetMap
	Container [][]netmap.NodeInfo
}

// SGSource is a storage group information source interface.
type SGSource interface {
	// ListSG must list storage group objects in the container. Formed list must be written to destination.
	//
	// Must return any error encountered which did not allow to form the list.
	ListSG(*SearchSGDst, SearchSGPrm) error

	// GetSG must return storage group object for the provided CID, OID,
	// container and netmap state.
	GetSG(GetSGPrm) (*storagegroup.StorageGroup, error)
}

// StorageGroup combines storage group object ID and its structure.
type StorageGroup struct {
	id oid.ID
	sg storagegroup.StorageGroup
}

// ID returns object ID of the storage group.
func (s StorageGroup) ID() oid.ID {
	return s.id
}

// SetID sets an object ID of the storage group.
func (s *StorageGroup) SetID(id oid.ID) {
	s.id = id
}

// StorageGroup returns the storage group descriptor.
func (s StorageGroup) StorageGroup() storagegroup.StorageGroup {
	return s.sg
}

// SetStorageGroup sets a storage group descriptor.
func (s *StorageGroup) SetStorageGroup(sg storagegroup.StorageGroup) {
	s.sg = sg
}