dfsr

Documentation

Index

• type Backlog
  • func (b *Backlog) IsZero() bool
  • func (b *Backlog) Sum() (backlog uint)
• type Computer
• type Connection
• type Domain
  • func (d *Domain) MemberInfoMap() MemberInfoMap
• type Folder
• type FolderBacklog
• type Group
• type LocalSettings
• type Member
• type MemberInfo
• type MemberInfoMap
  • func (m MemberInfoMap) Resolve(key string) (info MemberInfo, ok bool)
• type NamingContext
• type Subscriber
• type Subscription
• type Tracker

Types

type Backlog

type Backlog struct {
	Group   *Group
	From    string
	To      string
	Folders []FolderBacklog
	Call    callstat.Call
	Err     error
}

Backlog represents the backlog from one DFSR member to another.

func (*Backlog) IsZero

func (b *Backlog) IsZero() bool

IsZero reports whether b represents a successful backlog query that returned a count of zero for all replication folders in the replication group.

func (*Backlog) Sum

func (b *Backlog) Sum() (backlog uint)

Sum returns the total backlog of all replicated folders. Negatives values, which incidate errors, are not included in the summation.

type Computer

type Computer struct {
	DN   string // Distinguished name
	Host string
}

Computer represents information about a computer.

type Connection

type Connection struct {
	Name     string
	ID       uuid.UUID
	MemberDN string
	Enabled  bool
	Computer Computer // Distinguished name of source member in topology, matches DN field of that Member
}

Connection represents a one-way connection between replication members.

type Domain

type Domain struct {
	NamingContext
	Groups         []Group
	ConfigDuration time.Duration // Time elapsed while retrieving configuration
}

Domain contains the replication group information for an Active Directory domain.

func (*Domain) MemberInfoMap

func (d *Domain) MemberInfoMap() MemberInfoMap

MemberInfoMap builds a map of members keyed by GUID. If d is nil it returns a nil map.

type Folder

type Folder struct {
	Name string
	ID   uuid.UUID
}

Folder represents a replication folder.

TODO: Consider renaming this to ContentSet.

type FolderBacklog

type FolderBacklog struct {
	Folder  *Folder
	Backlog int
}

FolderBacklog represents the backlog for an individual folder.

type Group

type Group struct {
	Name           string
	ID             uuid.UUID
	Folders        []Folder
	Members        []Member
	ConfigDuration time.Duration // Time elapsed while retrieving configuration
}

Group represents a replication group.

type LocalSettings

type LocalSettings struct {
	Version string // DFSR version
	Groups  []Subscriber
}

LocalSettings contains the local settings for a replication member. It includes configuration particular to that member, such as such as content set paths, staging directories, etc.

type Member

type Member struct {
	MemberInfo
	Connections []Connection
}

Member represents a replication member.

type MemberInfo

type MemberInfo struct {
	Name     string
	ID       uuid.UUID
	DN       string // Distinguished name of the member
	Computer Computer
	Settings LocalSettings
}

MemberInfo represents identifying information about a replication member.

type MemberInfoMap

type MemberInfoMap map[string]MemberInfo

MemberInfoMap maps member identifiers to member information.

func (MemberInfoMap) Resolve

func (m MemberInfoMap) Resolve(key string) (info MemberInfo, ok bool)

Resolve returns information about the member with the given key, which is typically a GUID in lower case.

type NamingContext

type NamingContext struct {
	ID          uuid.UUID
	DN          string // Distinguished name
	Description string
	Path        string
}

NamingContext represents an active directory naming context.

type Subscriber

type Subscriber struct {
	MemberReference  string
	ReplicationGroup uuid.UUID
	ContentSets      []Subscription
}

Subscriber contains the set of content set subscriptions for a replication group member.

type Subscription

type Subscription struct {
	ReplicationGroup uuid.UUID
	ContentSet       uuid.UUID
	RootPath         string
	RootSize         int // In Mibibytes (TODO: Convert to bytes?)
	StagingPath      string
	StagingSize      int // In Mibibytes (TODO: Convert to bytes?)
	ConflictPath     string
	ConflictSize     int // In Mibibytes (TODO: Convert to bytes?)
	Enabled          bool
	ReadOnly         bool
	Options          int // Enum flags
	CachePolicy      int // Enum flags
	MaxAgeInCache    time.Duration
	MinDurationCache time.Duration
}

Subscription represents the content set settings for a replication group member.

type Tracker

type Tracker interface {
	Add() (call calltracker.TrackedCall)
	Value() (value calltracker.Value)
	Subscribe(s calltracker.Subscriber)
}

Tracker represents a call state tracker.