774d408e13
Initially I wasn't 100% clear or decided on the send/recv semantics. After some experimenting, I think this is much closer to what we want. Nothing should break or regress here, this only enables more possibilities.
112 lines
4.6 KiB
Go
112 lines
4.6 KiB
Go
// Mgmt
|
|
// Copyright (C) James Shubin and the project contributors
|
|
// Written by James Shubin <james@shubin.ca> and the project contributors
|
|
//
|
|
// This program is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
//
|
|
// Additional permission under GNU GPL version 3 section 7
|
|
//
|
|
// If you modify this program, or any covered work, by linking or combining it
|
|
// with embedded mcl code and modules (and that the embedded mcl code and
|
|
// modules which link with this program, contain a copy of their source code in
|
|
// the authoritative form) containing parts covered by the terms of any other
|
|
// license, the licensors of this program grant you additional permission to
|
|
// convey the resulting work. Furthermore, the licensors of this program grant
|
|
// the original author, James Shubin, additional permission to update this
|
|
// additional permission if he deems it necessary to achieve the goals of this
|
|
// additional permission.
|
|
|
|
package traits
|
|
|
|
import (
|
|
"github.com/purpleidea/mgmt/engine"
|
|
)
|
|
|
|
// Sendable contains a general implementation with some of the properties and
|
|
// methods needed to implement sending from resources. You'll need to implement
|
|
// the Sends method, and call the Send method in CheckApply via the Init API.
|
|
type Sendable struct {
|
|
send interface{}
|
|
//sendIsActive bool // TODO: public?
|
|
|
|
// Bug5819 works around issue https://github.com/golang/go/issues/5819
|
|
Bug5819 interface{} // XXX: workaround
|
|
}
|
|
|
|
// Sends returns a struct containing the defaults of the type we send. This
|
|
// needs to be implemented (overridden) by the struct with the Sendable trait to
|
|
// be able to send any values. The field struct tag names are the keys used.
|
|
func (obj *Sendable) Sends() interface{} {
|
|
return nil
|
|
}
|
|
|
|
// Send is used to send a struct in CheckApply. This is typically wrapped in the
|
|
// resource API and consumed that way.
|
|
func (obj *Sendable) Send(st interface{}) error {
|
|
// TODO: can we (or should we) run the type checking here instead?
|
|
obj.send = st
|
|
return nil
|
|
}
|
|
|
|
// Sent returns the struct of values that have been sent by this resource.
|
|
func (obj *Sendable) Sent() interface{} {
|
|
return obj.send
|
|
}
|
|
|
|
// SendActive let's the resource know if it must send a value. This is usually
|
|
// called during CheckApply, but it's probably safe to check it during Init as
|
|
// well. This is the implementation of this function.
|
|
// XXX: Not doing this for now, see the interface for more information.
|
|
//func (obj *Sendable) SendActive() bool {
|
|
// return obj.sendIsActive
|
|
//}
|
|
|
|
// SendSetActive is used by the compiler to store the "SendActive" bool so that
|
|
// it will later know if it will need to send or not. Only the engine should
|
|
// call this function. This is the implementation of this function.
|
|
// TODO: We could instead pass in the various edges we will be sending, and
|
|
// store a map of those for the resource to know more precisely.
|
|
// XXX: Not doing this for now, see the interface for more information.
|
|
//func (obj *Sendable) SendSetActive(b bool) {
|
|
// obj.sendIsActive = b
|
|
//}
|
|
|
|
// Recvable contains a general implementation with some of the properties and
|
|
// methods needed to implement receiving from resources.
|
|
type Recvable struct {
|
|
recv map[string]*engine.Send
|
|
|
|
// Bug5819 works around issue https://github.com/golang/go/issues/5819
|
|
Bug5819 interface{} // XXX: workaround
|
|
}
|
|
|
|
// SetRecv is used to inject incoming values into the resource. More
|
|
// specifically, it stores the mapping of what gets received from what, so that
|
|
// later on, we know which resources should ask which other resources for the
|
|
// values that they want to receive. Since this happens when we're building the
|
|
// graph, and before the autogrouping step, we'll have pointers to the original,
|
|
// ungrouped resources here, so that it will work even after they're grouped in!
|
|
func (obj *Recvable) SetRecv(recv map[string]*engine.Send) {
|
|
//if obj.recv == nil {
|
|
// obj.recv = make(map[string]*engine.Send)
|
|
//}
|
|
obj.recv = recv
|
|
}
|
|
|
|
// Recv is used to get information that was passed in. This data can then be
|
|
// used to run the Send/Recv data transfer.
|
|
func (obj *Recvable) Recv() map[string]*engine.Send {
|
|
return obj.recv
|
|
}
|