spacestatus

Documentation

Index

• Constants
• Variables
• type AccountDeletion
• type AccountInfo
• type ChangeVerifier
• type Config
• type Deleter
• type SpaceDeleter
• type SpaceDeletion
• type SpaceStatus
  • func New() SpaceStatus
• type SpaceType
  • func VerifySpaceHeader(identity crypto.PubKey, headerBytes []byte) (spaceType SpaceType, err error)
• type StatusChange
• type StatusEntry

Constants

const (
	SpaceStatusCreated = iota
	SpaceStatusDeletionPending
	SpaceStatusDeletionStarted
	SpaceStatusDeleted
)

const CName = "coordinator.spacestatus"

Variables

var (
	ErrStatusExists = errors.New("space status exists")
)

Types

type AccountDeletion

type AccountDeletion struct {
	DeletionPayload   []byte
	DeletionPayloadId string
	AccountInfo
}

type AccountInfo

type AccountInfo struct {
	Identity  crypto.PubKey
	PeerId    string
	NetworkId string
}

type ChangeVerifier

type ChangeVerifier interface {
	Verify(change StatusChange) (err error)
}

type Config

type Config struct {
	RunSeconds         int `yaml:"runSeconds"`
	DeletionPeriodDays int `yaml:"deletionPeriodDays"`
	SpaceLimit         int `yaml:"spaceLimit"`
}

type Deleter

type Deleter func(ctx context.Context, spaceId string) (err error)

type SpaceDeleter

type SpaceDeleter interface {
	Run(spaces *mongo.Collection, delSender Deleter)
	Close()
}

type SpaceDeletion

type SpaceDeletion struct {
	DeletionPayload   []byte
	DeletionPayloadId string
	SpaceId           string
	DeletionPeriod    time.Duration
	AccountInfo
}

type SpaceStatus

type SpaceStatus interface {
	NewStatus(ctx context.Context, spaceId string, identity, oldIdentity crypto.PubKey, spaceType SpaceType, force bool) (err error)
	// ChangeStatus is deprecated, use only for backwards compatibility
	ChangeStatus(ctx context.Context, change StatusChange) (entry StatusEntry, err error)
	SpaceDelete(ctx context.Context, payload SpaceDeletion) (toBeDeleted int64, err error)
	AccountDelete(ctx context.Context, payload AccountDeletion) (toBeDeleted int64, err error)
	AccountRevertDeletion(ctx context.Context, payload AccountInfo) (err error)
	Status(ctx context.Context, spaceId string) (entry StatusEntry, err error)

	MakeShareable(ctx context.Context, spaceId string, limit uint32) (err error)
	MakeUnshareable(ctx context.Context, spaceId string) (err error)

	app.ComponentRunnable
}

func New

func New() SpaceStatus

type SpaceType

type SpaceType int

const (
	SpaceTypePersonal SpaceType = iota
	SpaceTypeTech
	SpaceTypeRegular
)

func VerifySpaceHeader

func VerifySpaceHeader(identity crypto.PubKey, headerBytes []byte) (spaceType SpaceType, err error)

type StatusChange

type StatusChange struct {
	DeletionPayloadType coordinatorproto.DeletionPayloadType
	DeletionPayload     []byte
	DeletionPayloadId   string
	Identity            crypto.PubKey
	// DeletionTimestamp is ignored when setting in ChangeStatus
	DeletionTimestamp int64
	// ToBeDeletedTimestamp is ignored when setting in ChangeStatus
	ToBeDeletedTimestamp int64
	Status               int
	PeerId               string
	SpaceId              string
	NetworkId            string
}

type StatusEntry

type StatusEntry struct {
	SpaceId              string    `bson:"_id"`
	Identity             string    `bson:"identity"`
	OldIdentity          string    `bson:"oldIdentity"`
	DeletionPayloadType  int       `bson:"deletionPayloadType"`
	DeletionPayload      []byte    `bson:"deletionPayload"`
	DeletionTimestamp    int64     `bson:"deletionTimestamp"`
	ToBeDeletedTimestamp int64     `bson:"toBeDeletedTimestamp"`
	Status               int       `bson:"status"`
	Type                 SpaceType `bson:"type"`
	IsShareable          bool      `bson:"isShareable"`
}