msp

Documentation

Index

• Constants
• type Consumer
• type Error
  • func (e Error) String() string
• type HostPort
• type Listener
  • func NewServer(listener Consumer, listenString string, caFile string, certFile string, ...) *Listener
  • func (s Listener) Run() error
• type MSPClient
• type MSPClientImpl
  • func (c MSPClientImpl) EstablishMongodState(target HostPort, m Mongod) *Error
  • func (c MSPClientImpl) InitiateReplicaSet(target HostPort, msg RsInitiateMessage) *Error
  • func (c MSPClientImpl) RequestStatus(Target HostPort) ([]Mongod, *Error)
• type Mongod
  • func (m Mongod) GoString() string
• type MongodCredential
  • func (m MongodCredential) GoString() string
• type MongodState
  • func (s MongodState) IsProcessExecuting() bool
• type PortNumber
• type ReplicaSetConfig
• type ReplicaSetMember
• type RsInitiateMessage
• type ShardingRole

Constants

const (
	MongodStateForceDestroyed = "forcedestroyed"
	MongodStateDestroyed      = "destroyed"
	MongodStateNotRunning     = "notrunning"
	MongodStateUninitialized  = "uninitiated"
	MongodStateRecovering     = "recovering"
	MongodStateRunning        = "running"
	MongodStateRemoved        = "removed"
)

const BadStateDescription string = "BADSTATE"

const CommunicationError string = "COMM" // slave is unreachable or slave response not understood

List of Error identifiers

const NotImplementedError string = "NOTIMPLEMENTED"

const SlaveConnectMongodError string = "SLAVECONERR"

const SlaveGetMongodStatusError string = "SLAVEGETSTATUSERR"

const SlaveMongodProtocolError string = "SLAVEMONGODPROTOERR"

const SlaveReplicaSetConfigError string = "SLAVEREPLSETCONFIG"

const SlaveReplicaSetCreateRootUserError string = "SLAVEREPLSETCREATEROOTUSER"

const SlaveReplicaSetInitError string = "SLAVEREPLSETINIT"

const SlaveShutdownError string = "SLAVESHUTDOWNERR"

const SlaveSpawnError string = "SLAVESPAWN"

Types

type Consumer

type Consumer interface {
	RequestStatus() ([]Mongod, *Error)
	EstablishMongodState(m Mongod) *Error
	RsInitiate(m RsInitiateMessage) *Error
}

type Error

type Error struct {
	// See constants in this package for list of identifiers
	Identifier      string
	Description     string
	LongDescription string
}

func (Error) String

func (e Error) String() string

type HostPort

type HostPort struct {
	Hostname string
	Port     PortNumber
}

type Listener

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

func NewServer

func NewServer(listener Consumer, listenString string, caFile string, certFile string, keyFile string) *Listener

func (Listener) Run

func (s Listener) Run() error

type MSPClient

type MSPClient interface {
	RequestStatus(Target HostPort) ([]Mongod, *Error)
	InitiateReplicaSet(Target HostPort, msg RsInitiateMessage) *Error
	EstablishMongodState(Target HostPort, m Mongod) *Error
}

type MSPClientImpl

type MSPClientImpl struct {
	HttpClient http.Client
}

func (MSPClientImpl) EstablishMongodState

func (c MSPClientImpl) EstablishMongodState(target HostPort, m Mongod) *Error

func (MSPClientImpl) InitiateReplicaSet

func (c MSPClientImpl) InitiateReplicaSet(target HostPort, msg RsInitiateMessage) *Error

func (MSPClientImpl) RequestStatus

func (c MSPClientImpl) RequestStatus(Target HostPort) ([]Mongod, *Error)

type Mongod

type Mongod struct {
	Port                    PortNumber
	KeyfileContent          string
	ReplicaSetConfig        ReplicaSetConfig
	StatusError             *Error
	LastEstablishStateError *Error
	State                   MongodState
}

func (Mongod) GoString

func (m Mongod) GoString() string

type MongodCredential

type MongodCredential struct {
	Username, Password string
}

func (MongodCredential) GoString

func (m MongodCredential) GoString() string

type MongodState

type MongodState string

func (MongodState) IsProcessExecuting

func (s MongodState) IsProcessExecuting() bool

type PortNumber

type PortNumber uint16

type ReplicaSetConfig

type ReplicaSetConfig struct {
	ReplicaSetName    string
	ReplicaSetMembers []ReplicaSetMember
	ShardingRole      ShardingRole
	RootCredential    MongodCredential // user with the Superuse Role `root`, see https://docs.mongodb.com/manual/reference/built-in-roles/#root
}

type ReplicaSetMember

type ReplicaSetMember struct {
	HostPort HostPort
	Priority float64
	Votes    int
}

type RsInitiateMessage

type RsInitiateMessage struct {
	Port             PortNumber
	ReplicaSetConfig ReplicaSetConfig
}

type ShardingRole

type ShardingRole string

const (
	ShardingRoleNone         ShardingRole = "none"
	ShardingRoleShardServer  ShardingRole = "shardsvr"
	ShardingRoleConfigServer ShardingRole = "configsvr"
)