common

package
v2.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 17, 2025 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

View Source
const (
	CorrelationID   = "X-Correlation-ID"
	ContentType     = "Content-Type"
	ContentTypeJSON = "application/json"
	ContentTypeText = "text/plain"
)
View Source
const (
	ApiVersion = "v1"
	ApiBase    = "/api/v1"

	ApiConfigRoute  = ApiBase + "/config"
	ApiPingRoute    = ApiBase + "/ping"
	ApiVersionRoute = ApiBase + "/version"
	ApiSecretRoute  = ApiBase + "/secret"
)
View Source
const (
	CommaSeparator = ","
	End            = "end"
	Limit          = "limit"
	Labels         = "labels"
	Offset         = "offset"
	Since          = "since"
	Start          = "start"
	Tail           = "tail"
	Timestamps     = "timestamps"
	Until          = "until"
)

constants relate to the url query parameters

View Source
const (
	ClientMonitorDefault = 15000              // Defaults the interval at which a given service client will refresh its endpoint from the Registry, if used
	CorrelationHeader    = "X-Correlation-ID" // Sets the key of the Correlation ID HTTP header
)

Miscellaneous constants

View Source
const (
	EdgeXApiBase       = "/api/v3"
	EdgeXApiKeyRoute   = EdgeXApiBase + "/key"
	EdgeXApiTokenRoute = EdgeXApiBase + "/" + Token
)

constants related to the EdgeX API

View Source
const (
	VerificationKeyType         = "verification"
	Issuer                      = "issuer"
	SecurityProxyAuthServiceKey = "security-proxy-auth"
)

Constants related to the security-proxy-auth service

View Source
const (
	EntityId = "entityId"
	Token    = "token"
)

Constants related to the security-secretstore-setup service

View Source
const (
	EnvKeyStartupDuration = "EDGE_STARTUP_DURATION"
	EnvKeyStartupInterval = "EDGE_STARTUP_INTERVAL"
	EnvKeyConfigDir       = "EDGE_CONFIG_DIR"
	EnvKeyConfigFile      = "EDGE_CONFIG_FILE"

	EnvSecretStore             = "EDGE_SECURITY_SECRET_STORE"
	EnvKeyDisableJWTValidation = "EDGE_DISABLE_JWT_VALIDATION"
)

Variables

This section is empty.

Functions

func URLEncode added in v2.0.1

func URLEncode(s string) string

URLEncode encodes the input string with additional common character support

Types

type PathBuilder

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

func NewPathBuilder

func NewPathBuilder() *PathBuilder

func (*PathBuilder) BuildPath

func (b *PathBuilder) BuildPath() string

func (*PathBuilder) EnableNameFieldEscape added in v2.0.1

func (b *PathBuilder) EnableNameFieldEscape(enableNameFieldEscape bool) *PathBuilder

func (*PathBuilder) SetNameFieldPath added in v2.0.1

func (b *PathBuilder) SetNameFieldPath(namePath string) *PathBuilder

SetNameFieldPath set name path, such as device name, profile name, interval name

func (*PathBuilder) SetPath

func (b *PathBuilder) SetPath(path string) *PathBuilder

type Queue

type Queue[T any] interface {
	// Enqueue method that adds a new item to the queue
	Enqueue(item T) errors.Error

	// Dequeue method that removes the first item from the items of the queue
	Dequeue()

	// Peek method that looks at the next item without removing it from the queue
	Peek() T

	// Size returns a number indicating how many items are in the queue
	Size() int
}

Queue is the interface for the queue

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL