d48fb81193
Implement a component for transmitting the value of the used container space along a route defined in the system. Implement WriterProvider interface on it. By implementation, it is the link between the route planner and the point-to-point transmitter, and abstracts from the implementation of both of them. In the future, this implementation will be used as a transmitter of local estimates of storage nodes among themselves. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
86 lines
2.2 KiB
Go
86 lines
2.2 KiB
Go
package loadroute
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/nspcc-dev/neofs-node/pkg/util/logger"
|
|
)
|
|
|
|
// Prm groups the required parameters of the Router's constructor.
|
|
//
|
|
// All values must comply with the requirements imposed on them.
|
|
// Passing incorrect parameter values will result in constructor
|
|
// failure (error or panic depending on the implementation).
|
|
type Prm struct {
|
|
// Characteristics of the local node's server.
|
|
//
|
|
// Must not be nil.
|
|
LocalServerInfo ServerInfo
|
|
|
|
// Component for sending values to a fixed route point.
|
|
//
|
|
// Must not be nil.
|
|
RemoteWriterProvider RemoteWriterProvider
|
|
|
|
// Route planner.
|
|
//
|
|
// Must not be nil.
|
|
Builder Builder
|
|
}
|
|
|
|
// Router represents component responsible for routing
|
|
// used container space values over the network.
|
|
//
|
|
// For each fixed pair (container ID, epoch) there is a
|
|
// single value route on the network. Router provides the
|
|
// interface for writing values to the next point of the route.
|
|
//
|
|
// For correct operation, Router must be created using
|
|
// the constructor (New) based on the required parameters
|
|
// and optional components. After successful creation,
|
|
// the Router is immediately ready to work through API.
|
|
type Router struct {
|
|
log *logger.Logger
|
|
|
|
remoteProvider RemoteWriterProvider
|
|
|
|
routeBuilder Builder
|
|
|
|
localSrvInfo ServerInfo
|
|
}
|
|
|
|
const invalidPrmValFmt = "invalid parameter %s (%T):%v"
|
|
|
|
func panicOnPrmValue(n string, v interface{}) {
|
|
panic(fmt.Sprintf(invalidPrmValFmt, n, v, v))
|
|
}
|
|
|
|
// New creates a new instance of the Router.
|
|
//
|
|
// Panics if at least one value of the parameters is invalid.
|
|
//
|
|
// The created Router does not require additional
|
|
// initialization and is completely ready for work.
|
|
func New(prm Prm, opts ...Option) *Router {
|
|
switch {
|
|
case prm.RemoteWriterProvider == nil:
|
|
panicOnPrmValue("RemoteWriterProvider", prm.RemoteWriterProvider)
|
|
case prm.Builder == nil:
|
|
panicOnPrmValue("Builder", prm.Builder)
|
|
case prm.LocalServerInfo == nil:
|
|
panicOnPrmValue("LocalServerInfo", prm.LocalServerInfo)
|
|
}
|
|
|
|
o := defaultOpts()
|
|
|
|
for i := range opts {
|
|
opts[i](o)
|
|
}
|
|
|
|
return &Router{
|
|
log: o.log,
|
|
remoteProvider: prm.RemoteWriterProvider,
|
|
routeBuilder: prm.Builder,
|
|
localSrvInfo: prm.LocalServerInfo,
|
|
}
|
|
}
|