luxolus/open-consul
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity

local state: update comments

Browse source
This commit is contained in:
Frank Schroeder 2017-10-18 15:05:57 +02:00
parent da604495a0
commit 2e3b72d2c3
No known key found for this signature in database
GPG key ID: 4D65C6EAEC87DECD
1 changed files with 12 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
agent/local/state.go
View file

@ -18,9 +18,7 @@ import (
"github.com/hashicorp/consul/types" "github.com/hashicorp/consul/types"
) )
// Config is the configuration for the State. It is // Config is the configuration for the State.
// populated during NewLocalAgent from the agent configuration to avoid
// race conditions with the agent configuration.
type Config struct { type Config struct {
AdvertiseAddr string AdvertiseAddr string
CheckUpdateInterval time.Duration CheckUpdateInterval time.Duration
@ -110,7 +108,7 @@ type rpc interface {
} }
// State is used to represent the node's services, // State is used to represent the node's services,
// and checks. We used it to perform anti-entropy with the // and checks. We use it to perform anti-entropy with the
// catalog representation // catalog representation
type State struct { type State struct {
sync.RWMutex sync.RWMutex
@ -154,7 +152,7 @@ type State struct {
tokens *token.Store tokens *token.Store
} }
// NewLocalState creates a is used to initialize the local state // NewLocalState creates a new local state for the agent.
func NewState(c Config, lg *log.Logger, tokens *token.Store) *State { func NewState(c Config, lg *log.Logger, tokens *token.Store) *State {
l := &State{ l := &State{
config: c, config: c,
@ -168,6 +166,8 @@ func NewState(c Config, lg *log.Logger, tokens *token.Store) *State {
return l return l
} }
// SetDiscardCheckOutput configures whether the check output
// is discarded. This can be changed at runtime.
func (l *State) SetDiscardCheckOutput(b bool) { func (l *State) SetDiscardCheckOutput(b bool) {
l.discardCheckOutput.Store(b) l.discardCheckOutput.Store(b)
} }
@ -181,6 +181,7 @@ func (l *State) ServiceToken(id string) string {
} }
// serviceToken returns an ACL token associated with a service. // serviceToken returns an ACL token associated with a service.
// This method is not synchronized and the lock must already be held.
func (l *State) serviceToken(id string) string { func (l *State) serviceToken(id string) string {
var token string var token string
if s := l.services[id]; s != nil { if s := l.services[id]; s != nil {
@ -310,6 +311,7 @@ func (l *State) CheckToken(checkID types.CheckID) string {
} }
// checkToken returns an ACL token associated with a check. // checkToken returns an ACL token associated with a check.
// This method is not synchronized and the lock must already be held.
func (l *State) checkToken(id types.CheckID) string { func (l *State) checkToken(id types.CheckID) string {
var token string var token string
c := l.checks[id] c := l.checks[id]
@ -500,7 +502,10 @@ func (l *State) CheckStates() map[types.CheckID]*CheckState {
} }
// CriticalCheckStates returns the locally registered checks that the // CriticalCheckStates returns the locally registered checks that the
// agent is aware of and are being kept in sync with the server // agent is aware of and are being kept in sync with the server.
// The map contains a shallow copy of the current check states but
// references to the actual check definition which must not be
// modified.
func (l *State) CriticalCheckStates() map[types.CheckID]*CheckState { func (l *State) CriticalCheckStates() map[types.CheckID]*CheckState {
l.RLock() l.RLock()
defer l.RUnlock() defer l.RUnlock()