atomicstate

Documentation

Overview

Code generated by github.com/ngicks/gommon/pkg/atomicstate/cmd/generate_state_impl/generate_state_impl.go. DO NOT EDIT.

Index

• func NewEndedState() (checker *EndedStateChecker, setter *EndedStateSetter)
• func NewRunningState() (checker *RunningStateChecker, setter *RunningStateSetter)
• func NewWorkingState() (checker *WorkingStateChecker, setter *WorkingStateSetter)
• type EndedState
  • func (s *EndedState) IsEnded() bool
  • func (s *EndedState) SetEnded(to ...bool) (swapped bool)
• type EndedStateChecker
  • func (s *EndedStateChecker) IsEnded() bool
• type EndedStateSetter
  • func (s *EndedStateSetter) SetEnded(to ...bool) (swapped bool)
• type RunningState
  • func (s *RunningState) IsRunning() bool
  • func (s *RunningState) SetRunning(to ...bool) (swapped bool)
• type RunningStateChecker
  • func (s *RunningStateChecker) IsRunning() bool
• type RunningStateSetter
  • func (s *RunningStateSetter) SetRunning(to ...bool) (swapped bool)
• type WorkingState
  • func (s *WorkingState) IsWorking() bool
  • func (s *WorkingState) SetWorking(to ...bool) (swapped bool)
• type WorkingStateChecker
  • func (s *WorkingStateChecker) IsWorking() bool
• type WorkingStateSetter
  • func (s *WorkingStateSetter) SetWorking(to ...bool) (swapped bool)

Functions

func NewEndedState

func NewEndedState() (checker *EndedStateChecker, setter *EndedStateSetter)

NewEndedState builds splitted EndedState wrapper. Either or both can be embedded and/or used as unexported member to hide its setter.

func NewRunningState

func NewRunningState() (checker *RunningStateChecker, setter *RunningStateSetter)

NewRunningState builds splitted RunningState wrapper. Either or both can be embedded and/or used as unexported member to hide its setter.

func NewWorkingState

func NewWorkingState() (checker *WorkingStateChecker, setter *WorkingStateSetter)

NewWorkingState builds splitted WorkingState wrapper. Either or both can be embedded and/or used as unexported member to hide its setter.

Types

type EndedState

type EndedState struct {
	// contains filtered or unexported fields
}

EndedState is atomic state primitive. It holds a boolean state corresponds to its name.

func (*EndedState) IsEnded

func (s *EndedState) IsEnded() bool

IsEnded is atomic state checker. It returns true if state is set, and vice versa.

func (*EndedState) SetEnded

func (s *EndedState) SetEnded(to ...bool) (swapped bool)

SetEnded is atomic state setter. It tries to set its state based on to. If first element of to is false, it tries set it to false, true otherwise.

swapped is true when it is successfully set, false if it is already set to the state.

type EndedStateChecker

type EndedStateChecker struct {
	// contains filtered or unexported fields
}

EndedStateSetter is simple wrapper of EndedState. It only exposes IsEnded.

func (*EndedStateChecker) IsEnded

func (s *EndedStateChecker) IsEnded() bool

IsEnded is atomic state checker. It returns true if state is set, and vice versa.

type EndedStateSetter

type EndedStateSetter struct {
	// contains filtered or unexported fields
}

EndedStateSetter is simple wrapper of EndedState. It only exposes SetEnded.

func (*EndedStateSetter) SetEnded

func (s *EndedStateSetter) SetEnded(to ...bool) (swapped bool)

SetEnded is atomic state setter. It tries to set its state based on to. If first element of to is false, it tries set it to false, true otherwise.

swapped is true when it is successfully set, false if it is already set to the state.

type RunningState

type RunningState struct {
	// contains filtered or unexported fields
}

RunningState is atomic state primitive. It holds a boolean state corresponds to its name.

func (*RunningState) IsRunning

func (s *RunningState) IsRunning() bool

IsRunning is atomic state checker. It returns true if state is set, and vice versa.

func (*RunningState) SetRunning

func (s *RunningState) SetRunning(to ...bool) (swapped bool)

SetRunning is atomic state setter. It tries to set its state based on to. If first element of to is false, it tries set it to false, true otherwise.

swapped is true when it is successfully set, false if it is already set to the state.

type RunningStateChecker

type RunningStateChecker struct {
	// contains filtered or unexported fields
}

RunningStateSetter is simple wrapper of RunningState. It only exposes IsRunning.

func (*RunningStateChecker) IsRunning

func (s *RunningStateChecker) IsRunning() bool

IsRunning is atomic state checker. It returns true if state is set, and vice versa.

type RunningStateSetter

type RunningStateSetter struct {
	// contains filtered or unexported fields
}

RunningStateSetter is simple wrapper of RunningState. It only exposes SetRunning.

func (*RunningStateSetter) SetRunning

func (s *RunningStateSetter) SetRunning(to ...bool) (swapped bool)

SetRunning is atomic state setter. It tries to set its state based on to. If first element of to is false, it tries set it to false, true otherwise.

swapped is true when it is successfully set, false if it is already set to the state.

type WorkingState

type WorkingState struct {
	// contains filtered or unexported fields
}

WorkingState is atomic state primitive. It holds a boolean state corresponds to its name.

func (*WorkingState) IsWorking

func (s *WorkingState) IsWorking() bool

IsWorking is atomic state checker. It returns true if state is set, and vice versa.

func (*WorkingState) SetWorking

func (s *WorkingState) SetWorking(to ...bool) (swapped bool)

SetWorking is atomic state setter. It tries to set its state based on to. If first element of to is false, it tries set it to false, true otherwise.

swapped is true when it is successfully set, false if it is already set to the state.

type WorkingStateChecker

type WorkingStateChecker struct {
	// contains filtered or unexported fields
}

WorkingStateSetter is simple wrapper of WorkingState. It only exposes IsWorking.

func (*WorkingStateChecker) IsWorking

func (s *WorkingStateChecker) IsWorking() bool

IsWorking is atomic state checker. It returns true if state is set, and vice versa.

type WorkingStateSetter

type WorkingStateSetter struct {
	// contains filtered or unexported fields
}

WorkingStateSetter is simple wrapper of WorkingState. It only exposes SetWorking.

func (*WorkingStateSetter) SetWorking

func (s *WorkingStateSetter) SetWorking(to ...bool) (swapped bool)

SetWorking is atomic state setter. It tries to set its state based on to. If first element of to is false, it tries set it to false, true otherwise.

swapped is true when it is successfully set, false if it is already set to the state.