[#1431] node: Fix comment format

Signed-off-by: Alexander Chuprov <a.chuprov@yadro.com>
This commit is contained in:
Alexander Chuprov 2024-10-14 18:05:55 +03:00 committed by Evgenii Stratonikov
parent f6582081a4
commit d83879d4b8
19 changed files with 30 additions and 30 deletions

View file

@ -52,7 +52,7 @@ func Address(c *config.Config) string {
return AddressDefault return AddressDefault
} }
// BlockRates returns the value of "block_rate" config parameter // BlockRate returns the value of "block_rate" config parameter
// from "pprof" section. // from "pprof" section.
func BlockRate(c *config.Config) int { func BlockRate(c *config.Config) int {
s := c.Sub(subsection) s := c.Sub(subsection)

View file

@ -117,7 +117,7 @@ func (i *delNetInfo) TombstoneLifetime() (uint64, error) {
return i.cfg.cfgObject.tombstoneLifetime.Load(), nil return i.cfg.cfgObject.tombstoneLifetime.Load(), nil
} }
// returns node owner ID calculated from configured private key. // LocalNodeID returns node owner ID calculated from configured private key.
// //
// Implements method needed for Object.Delete service. // Implements method needed for Object.Delete service.
func (i *delNetInfo) LocalNodeID() user.ID { func (i *delNetInfo) LocalNodeID() user.ID {

View file

@ -2,6 +2,6 @@ package netmap
// AnnouncedKeys is an interface of utility for working with the announced public keys of the storage nodes. // AnnouncedKeys is an interface of utility for working with the announced public keys of the storage nodes.
type AnnouncedKeys interface { type AnnouncedKeys interface {
// Checks if the key was announced by a local node. // IsLocalKey checks if the key was announced by a local node.
IsLocalKey(key []byte) bool IsLocalKey(key []byte) bool
} }

View file

@ -8,38 +8,38 @@ import (
// Record is an interface of read-only // Record is an interface of read-only
// FrostFS LOCODE database single entry. // FrostFS LOCODE database single entry.
type Record interface { type Record interface {
// Must return ISO 3166-1 alpha-2 // CountryCode must return ISO 3166-1 alpha-2
// country code. // country code.
// //
// Must not return nil. // Must not return nil.
CountryCode() *locodedb.CountryCode CountryCode() *locodedb.CountryCode
// Must return English short country name // CountryName must return English short country name
// officially used by the ISO 3166 // officially used by the ISO 3166
// Maintenance Agency (ISO 3166/MA). // Maintenance Agency (ISO 3166/MA).
CountryName() string CountryName() string
// Must return UN/LOCODE 3-character code // LocationCode must return UN/LOCODE 3-character code
// for the location (numerals 2-9 may also // for the location (numerals 2-9 may also
// be used). // be used).
// //
// Must not return nil. // Must not return nil.
LocationCode() *locodedb.LocationCode LocationCode() *locodedb.LocationCode
// Must return name of the location which // LocationName must return name of the location which
// have been allocated a UN/LOCODE without // have been allocated a UN/LOCODE without
// diacritic sign. // diacritic sign.
LocationName() string LocationName() string
// Must return ISO 1-3 character alphabetic // SubDivCode Must return ISO 1-3 character alphabetic
// and/or numeric code for the administrative // and/or numeric code for the administrative
// division of the country concerned. // division of the country concerned.
SubDivCode() string SubDivCode() string
// Must return subdivision name. // SubDivName must return subdivision name.
SubDivName() string SubDivName() string
// Must return existing continent where is // Continent must return existing continent where is
// the location. // the location.
// //
// Must not return nil. // Must not return nil.
@ -49,7 +49,7 @@ type Record interface {
// DB is an interface of read-only // DB is an interface of read-only
// FrostFS LOCODE database. // FrostFS LOCODE database.
type DB interface { type DB interface {
// Must find the record that corresponds to // Get must find the record that corresponds to
// LOCODE and provides the Record interface. // LOCODE and provides the Record interface.
// //
// Must return an error if Record is nil. // Must return an error if Record is nil.

View file

@ -43,7 +43,7 @@ type (
// of information about the node and its finalization for adding // of information about the node and its finalization for adding
// to the network map. // to the network map.
NodeValidator interface { NodeValidator interface {
// Must verify and optionally update NodeInfo structure. // VerifyAndUpdate must verify and optionally update NodeInfo structure.
// //
// Must return an error if NodeInfo input is invalid. // Must return an error if NodeInfo input is invalid.
// Must return an error if it is not possible to correctly // Must return an error if it is not possible to correctly

View file

@ -22,7 +22,7 @@ type MetricsWriter interface {
// SetShardID must set (update) the shard identifier that will be used in // SetShardID must set (update) the shard identifier that will be used in
// metrics. // metrics.
SetShardID(id string) SetShardID(id string)
// SetReadonly must set shard mode. // SetMode set mode of shard.
SetMode(mode mode.Mode) SetMode(mode mode.Mode)
// SetContainerObjectsCount sets container object count. // SetContainerObjectsCount sets container object count.
SetContainerObjectsCount(cnrID string, objectType string, value uint64) SetContainerObjectsCount(cnrID string, objectType string, value uint64)

View file

@ -16,7 +16,7 @@ type actorProvider interface {
GetRPCActor() actor.RPCActor GetRPCActor() actor.RPCActor
} }
// Client switches an established connection with neo-go if it is broken. // SwitchRPCGuardedActor switches an established connection with neo-go if it is broken.
// This leads to an invalidation of an rpc actor within Client. That means the // This leads to an invalidation of an rpc actor within Client. That means the
// components that are initilized with the rpc actor may unintentionally use // components that are initilized with the rpc actor may unintentionally use
// it when it is already invalidated. SwitchRPCGuardedActor is used to prevent // it when it is already invalidated. SwitchRPCGuardedActor is used to prevent

View file

@ -46,7 +46,7 @@ const (
// put container requests. // put container requests.
PutNotaryEvent = "put" PutNotaryEvent = "put"
// PutNotaryEvent is an ID of notary "put named container" notification. // PutNamedNotaryEvent is an ID of notary "put named container" notification.
PutNamedNotaryEvent = "putNamed" PutNamedNotaryEvent = "putNamed"
) )

View file

@ -67,11 +67,11 @@ func (x AddressGroup) Swap(i, j int) {
// MultiAddressIterator is an interface of network address group. // MultiAddressIterator is an interface of network address group.
type MultiAddressIterator interface { type MultiAddressIterator interface {
// Must iterate over network addresses and pass each one // IterateAddresses must iterate over network addresses and pass each one
// to the handler until it returns true. // to the handler until it returns true.
IterateAddresses(func(string) bool) IterateAddresses(func(string) bool)
// Must return number of addresses in group. // NumberOfAddresses must return number of addresses in group.
NumberOfAddresses() int NumberOfAddresses() int
} }

View file

@ -5,7 +5,7 @@ import control "git.frostfs.info/TrueCloudLab/frostfs-node/pkg/services/control/
// HealthChecker is component interface for calculating // HealthChecker is component interface for calculating
// the current health status of a node. // the current health status of a node.
type HealthChecker interface { type HealthChecker interface {
// Must calculate and return current health status of the IR application. // HealthStatus must calculate and return current health status of the IR application.
// //
// If status can not be calculated for any reason, // If status can not be calculated for any reason,
// control.HealthStatus_HEALTH_STATUS_UNDEFINED should be returned. // control.HealthStatus_HEALTH_STATUS_UNDEFINED should be returned.

View file

@ -292,7 +292,7 @@ func ListTargetsLocalOverrides(cli *client.Client, req *ListTargetsLocalOverride
return wResp.message, nil return wResp.message, nil
} }
// RemoveChainLocalOverride executes ControlService.RemoveChainLocalOverride RPC. // GetChainLocalOverride executes ControlService.RemoveChainLocalOverride RPC.
func GetChainLocalOverride(cli *client.Client, req *GetChainLocalOverrideRequest, opts ...client.CallOption) (*GetChainLocalOverrideResponse, error) { func GetChainLocalOverride(cli *client.Client, req *GetChainLocalOverrideRequest, opts ...client.CallOption) (*GetChainLocalOverrideResponse, error) {
wResp := newResponseWrapper[GetChainLocalOverrideResponse]() wResp := newResponseWrapper[GetChainLocalOverrideResponse]()
wReq := &requestWrapper{m: req} wReq := &requestWrapper{m: req}

View file

@ -26,13 +26,13 @@ type Server struct {
// HealthChecker is component interface for calculating // HealthChecker is component interface for calculating
// the current health status of a node. // the current health status of a node.
type HealthChecker interface { type HealthChecker interface {
// Must calculate and return current status of the node in FrostFS network map. // NetmapStatus must calculate and return current status of the node in FrostFS network map.
// //
// If status can not be calculated for any reason, // If status can not be calculated for any reason,
// control.netmapStatus_STATUS_UNDEFINED should be returned. // control.netmapStatus_STATUS_UNDEFINED should be returned.
NetmapStatus() control.NetmapStatus NetmapStatus() control.NetmapStatus
// Must calculate and return current health status of the node application. // HealthStatus must calculate and return current health status of the node application.
// //
// If status can not be calculated for any reason, // If status can not be calculated for any reason,
// control.HealthStatus_HEALTH_STATUS_UNDEFINED should be returned. // control.HealthStatus_HEALTH_STATUS_UNDEFINED should be returned.

View file

@ -26,7 +26,7 @@ type executorSvc struct {
// NodeState encapsulates information // NodeState encapsulates information
// about current node state. // about current node state.
type NodeState interface { type NodeState interface {
// Must return current node state // LocalNodeInfo must return current node state
// in FrostFS API v2 NodeInfo structure. // in FrostFS API v2 NodeInfo structure.
LocalNodeInfo() (*netmap.NodeInfo, error) LocalNodeInfo() (*netmap.NodeInfo, error)
@ -39,7 +39,7 @@ type NodeState interface {
// NetworkInfo encapsulates source of the // NetworkInfo encapsulates source of the
// recent information about the FrostFS network. // recent information about the FrostFS network.
type NetworkInfo interface { type NetworkInfo interface {
// Must return recent network information in FrostFS API v2 NetworkInfo structure. // Dump must return recent network information in FrostFS API v2 NetworkInfo structure.
// //
// If protocol version is <=2.9, MillisecondsPerBlock and network config should be unset. // If protocol version is <=2.9, MillisecondsPerBlock and network config should be unset.
Dump(versionsdk.Version) (*netmapSDK.NetworkInfo, error) Dump(versionsdk.Version) (*netmapSDK.NetworkInfo, error)

View file

@ -28,7 +28,7 @@ type distributedWriter struct {
resetSuccessAfterOnBroadcast bool resetSuccessAfterOnBroadcast bool
} }
// parameters and state of container Traversal. // Traversal parameters and state of container.
type Traversal struct { type Traversal struct {
Opts []placement.Option Opts []placement.Option

View file

@ -27,11 +27,11 @@ type Option func(*cfg)
type NetworkInfo interface { type NetworkInfo interface {
netmap.State netmap.State
// Must return the lifespan of the tombstones // TombstoneLifetime must return the lifespan of the tombstones
// in the FrostFS epochs. // in the FrostFS epochs.
TombstoneLifetime() (uint64, error) TombstoneLifetime() (uint64, error)
// Returns user ID of the local storage node. Result must not be nil. // LocalNodeID returns user ID of the local storage node. Result must not be nil.
// New tombstone objects will have the result as an owner ID if removal is executed w/o a session. // New tombstone objects will have the result as an owner ID if removal is executed w/o a session.
LocalNodeID() user.ID LocalNodeID() user.ID
} }

View file

@ -26,7 +26,7 @@ func NewService(cfg *objectwriter.Config,
} }
} }
// Put calls internal service and returns v2 object streamer. // Patch calls internal service and returns v2 object streamer.
func (s *Service) Patch() (object.PatchObjectStream, error) { func (s *Service) Patch() (object.PatchObjectStream, error) {
nodeKey, err := s.Config.KeyStorage.GetKey(nil) nodeKey, err := s.Config.KeyStorage.GetKey(nil)
if err != nil { if err != nil {

View file

@ -143,7 +143,7 @@ func WithPlacementBuilder(v placement.Builder) Option {
} }
} }
// WithRemoteObjectHeader returns option to set remote object header receiver of Policer. // WithRemoteObjectHeaderFunc returns option to set remote object header receiver of Policer.
func WithRemoteObjectHeaderFunc(v RemoteObjectHeaderFunc) Option { func WithRemoteObjectHeaderFunc(v RemoteObjectHeaderFunc) Option {
return func(c *cfg) { return func(c *cfg) {
c.remoteHeader = v c.remoteHeader = v

View file

@ -13,7 +13,7 @@ func Uint64() uint64 {
return source.Uint64() return source.Uint64()
} }
// Uint64 returns a random uint32 value. // Uint32 returns a random uint32 value.
func Uint32() uint32 { func Uint32() uint32 {
return source.Uint32() return source.Uint32()
} }

View file

@ -24,7 +24,7 @@ var (
errSocketIsNotInitialized = errors.New("socket is not initialized") errSocketIsNotInitialized = errors.New("socket is not initialized")
) )
// Initializes socket with provided name of // InitSocket initializes socket with provided name of
// environment variable. // environment variable.
func InitSocket() error { func InitSocket() error {
notifySocket := os.Getenv("NOTIFY_SOCKET") notifySocket := os.Getenv("NOTIFY_SOCKET")