walmanager

Documentation

Index

• type Manager
  • func OpenManager() (Manager, error)

Types

type Manager

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)

	// GetAllAvailableWALInfo returns all available channel info.
	GetAllAvailableChannels() ([]types.PChannelInfo, 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()
}

Manager is the interface for managing the wal instances.

func OpenManager

func OpenManager() (Manager, error)

OpenManager create a wal manager.