open-cluster-management/vendor/open-cluster-management.io/sdk-go/pkg/cloudevents/server/grpc/options.go

package grpc

import (
	"fmt"
	"time"

	"github.com/spf13/pflag"
)

// BrokerOptions contains configuration options for the GRPCBroker.
type BrokerOptions struct {
	// HeartbeatDisabled controls whether heartbeat mechanism is disabled.
	// Default: false (heartbeat is enabled by default)
	HeartbeatDisabled bool

	// HeartbeatCheckInterval is the interval for heartbeat checks.
	// Default: 10 seconds
	HeartbeatCheckInterval time.Duration
}

// NewBrokerOptions creates a new BrokerOptions with default values.
func NewBrokerOptions() *BrokerOptions {
	return &BrokerOptions{
		HeartbeatDisabled:      false,
		HeartbeatCheckInterval: 10 * time.Second,
	}
}

// AddFlags adds flags for configuring the broker options.
func (o *BrokerOptions) AddFlags(fs *pflag.FlagSet) {
	fs.BoolVar(&o.HeartbeatDisabled, "broker-heartbeat-disabled", o.HeartbeatDisabled,
		"Disable heartbeat mechanism for gRPC broker")
	fs.DurationVar(&o.HeartbeatCheckInterval, "broker-heartbeat-interval", o.HeartbeatCheckInterval,
		"Interval for heartbeat checks in gRPC broker")
}

// Validate checks the broker options for valid values.
func (o *BrokerOptions) Validate() error {
	// Validate heartbeat check interval if heartbeat is enabled
	if !o.HeartbeatDisabled && o.HeartbeatCheckInterval < 10*time.Second {
		return fmt.Errorf("heartbeat_check_interval (%v) must be at least 10 seconds when heartbeat is enabled", o.HeartbeatCheckInterval)
	}
	return nil
}