fix(comment): Add a few missing comments on func
This commit is contained in:
parent
8aedb85605
commit
582a9e6192
@ -22,6 +22,7 @@ func (e ProviderName) IsValid() bool {
|
||||
return false
|
||||
}
|
||||
|
||||
// String will transform a providerName into a string.
|
||||
func (e ProviderName) String() string {
|
||||
return string(e)
|
||||
}
|
||||
|
@ -103,6 +103,7 @@ func InitFromCustomConfig(c *ConfigStruct) (*logrus.Entry, error) {
|
||||
return c.applyExtraFields(logrus.NewEntry(log)), nil
|
||||
}
|
||||
|
||||
// applyExtraFileds will take a logrus.Entry and will add fields that are in the configuration.
|
||||
func (c *ConfigStruct) applyExtraFields(l *logrus.Entry) *logrus.Entry {
|
||||
return l.WithFields(c.ExtrasFields)
|
||||
}
|
||||
|
@ -18,11 +18,14 @@ const defaultShutdownTimeout = 10 * time.Second
|
||||
|
||||
type cleanupFunc func() error
|
||||
|
||||
// ExecuteServerParams are the parameters expected in the ExecuteServer function.
|
||||
type ExecuteServerParams struct {
|
||||
Cleanup cleanupFunc
|
||||
ShutdownTimeout *time.Duration
|
||||
}
|
||||
|
||||
// ExecuteServer will launche a http.Server and handle the "exit" signals and gracefully stop the server
|
||||
// and call the cleanup function.
|
||||
func ExecuteServer(ctx context.Context, srv *http.Server, params *ExecuteServerParams) error {
|
||||
|
||||
log := commonctx.GetLogger(ctx)
|
||||
|
Loading…
Reference in New Issue
Block a user