types

Documentation

Index

• type Config
  • func (config Config) GetExpandedRoute(route string) string
  • func (config Config) GetHealthCheckUrl() string
  • func (config Config) GetRegistryProtocol() string
  • func (config Config) GetRegistryUrl() string
  • func (config Config) GetServiceProtocol() string
• type ServiceEndpoint

Types

type Config

type Config struct {
	// The Protocol that should be used to connect to the registry service. HTTP is used if not set.
	Protocol string
	// Host is the hostname or IP address of the registry service
	Host string
	// Port is the HTTP port of the registry service
	Port int
	// Type is the implementation type of the registry service, i.e. keeper
	Type string
	// ServiceKey is the key identifying the service for Registration and building the services base configuration path.
	ServiceKey string
	// ServiceHost is the hostname or IP address of the current running service using this module. May be left empty if not using registration
	ServiceHost string
	// ServicePort is the HTTP port of the current running service using this module. May be left unset if not using registration
	ServicePort int
	// The ServiceProtocol that should be used to call the current running service using this module. May be left empty if not using registration
	ServiceProtocol string
	// Health check callback route for the current running service using this module. May be left empty if not using registration
	CheckRoute string
	// Health check callback interval. May be left empty if not using registration
	CheckInterval string
	// AuthInjector is an interface to obtain a JWT and secure transport for remote service calls
	AuthInjector interfaces.AuthenticationInjector
	// EnableNameFieldEscape indicates whether enables NameFieldEscape in this service
	// The name field escape could allow the system to use special or Chinese characters in the different name fields, including device, profile, and so on.  If the EnableNameFieldEscape is false, some special characters might cause system error.
	// TODO: remove in EdgeX 4.0
	EnableNameFieldEscape bool
}

Config defines the information need to connect to the registry service and optionally register the service for discovery and health checks

func (Config) GetExpandedRoute

func (config Config) GetExpandedRoute(route string) string

func (Config) GetHealthCheckUrl

func (config Config) GetHealthCheckUrl() string

func (Config) GetRegistryProtocol

func (config Config) GetRegistryProtocol() string

func (Config) GetRegistryUrl

func (config Config) GetRegistryUrl() string

func (Config) GetServiceProtocol

func (config Config) GetServiceProtocol() string

type ServiceEndpoint

type ServiceEndpoint struct {
	ServiceId string
	Host      string
	Port      int
}

ServiceEndpoint defines the service information returned by GetServiceEndpoint() need to connect to the target service