utils

Documentation

Index

• Variables
• func CloseAndLog(log logging.StandardLogger, name string, closer io.Closer)
• func CtxWithSplitTimeout(ctx context.Context, splitFactor int, minTimeout time.Duration) (context.Context, context.CancelFunc)
• func Exists(path string) bool
• func ResetContextOnError(ctx context.Context) context.Context
• func SanitizeAddr(addr string) (string, error)
• func SetStatusAndEnd(span trace.Span, err error)
• func SquareSize(lenShares int) uint64
• func ValidateAddr(addr string) (string, error)
• type Sessions
  • func NewSessions() *Sessions
  • func (s *Sessions) StartSession(ctx context.Context, key any) (endSession func(), err error)

Variables

var ErrInvalidIP = errors.New("invalid IP address or hostname given")

Functions

func CloseAndLog

func CloseAndLog(log logging.StandardLogger, name string, closer io.Closer)

CloseAndLog closes the closer and logs any error that occurs. The function is handy wrapping to group closing and logging in one call for defer statements.

func CtxWithSplitTimeout

func CtxWithSplitTimeout(
	ctx context.Context,
	splitFactor int,
	minTimeout time.Duration,
) (context.Context, context.CancelFunc)

CtxWithSplitTimeout will split timeout stored in context by splitFactor and return the result if it is greater than minTimeout. minTimeout == 0 will be ignored, splitFactor <= 0 will be ignored

func Exists

func Exists(path string) bool

Exists checks whether file or directory exists under the given 'path' on the system.

func ResetContextOnError

func ResetContextOnError(ctx context.Context) context.Context

ResetContextOnError returns a fresh context if the given context has an error.

func SanitizeAddr

func SanitizeAddr(addr string) (string, error)

SanitizeAddr trims leading protocol scheme and port from the given IP address or hostname if present.

func SetStatusAndEnd

func SetStatusAndEnd(span trace.Span, err error)

SetStatusAndEnd sets the status of the span depending on the contents of the passed error and ends it.

func SquareSize

func SquareSize(lenShares int) uint64

SquareSize returns the size of the square based on the given amount of shares.

func ValidateAddr

func ValidateAddr(addr string) (string, error)

ValidateAddr sanitizes the given address and verifies that it is a valid IP or hostname. The sanitized address is returned.

Types

type Sessions

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

Sessions manages concurrent sessions for the specified key. It ensures only one session can proceed for each key, avoiding duplicate efforts. If a session is already active for the given key, it waits until the session completes or context error occurs.

func NewSessions

func NewSessions() *Sessions

func (*Sessions) StartSession

func (s *Sessions) StartSession(
	ctx context.Context,
	key any,
) (endSession func(), err error)

StartSession attempts to start a new session for the given key. It provides a release function to clean up the session lock for this key, once the session is complete.