package walmanager

import (
	"context"

	"github.com/milvus-io/milvus/internal/streamingnode/server/wal"
	"github.com/milvus-io/milvus/pkg/v3/streaming/util/types"
)

var _ Manager = (*managerImpl)(nil)

// Manager is the interface for managing the wal instances.
type Manager interface {
	// Open opens a wal instance for the channel on this Manager.
	// Return `IgnoreOperation` error if the channel is not found.
	// Return `UnmatchedChannelTerm` error if the channel term is not matched.
	Open(ctx context.Context, channel types.PChannelInfo) error

	// GetAvailableWAL returns a available wal instance for the channel.
	// Return nil if the wal instance is not found.
	GetAvailableWAL(channel types.PChannelInfo) (wal.WAL, error)

	// Metrics return all the metrics of current wal manager.
	Metrics() (*types.StreamingNodeMetrics, error)

	// Remove removes the wal instance for the channel.
	// Return `IgnoreOperation` error if the channel is not found.
	// Return `UnmatchedChannelTerm` error if the channel term is not matched.
	Remove(ctx context.Context, channel types.PChannelInfo) error

	// Close these manager and release all managed WAL.
	Close()
}
