constant

Documentation

Index

• Constants
• type ClientConfig
  • func NewClientConfig(opts ...ClientOption) *ClientConfig
• type ClientOption
  • func WithAccessKey(accessKey string) ClientOption
  • func WithBeatInterval(beatInterval int64) ClientOption
  • func WithCacheDir(cacheDir string) ClientOption
  • func WithCustomLogger(logger logger.Logger) ClientOption
  • func WithEndpoint(endpoint string) ClientOption
  • func WithLogDir(logDir string) ClientOption
  • func WithLogLevel(logLevel string) ClientOption
  • func WithLogRollingConfig(rollingConfig *lumberjack.Logger) ClientOption
  • func WithLogSampling(tick time.Duration, initial int, thereafter int) ClientOption
  • func WithLogStdout(logStdout bool) ClientOption
  • func WithNamespaceId(namespaceId string) ClientOption
  • func WithNotLoadCacheAtStart(notLoadCacheAtStart bool) ClientOption
  • func WithOpenKMS(openKMS bool) ClientOption
  • func WithPassword(password string) ClientOption
  • func WithRegionId(regionId string) ClientOption
  • func WithSecretKey(secretKey string) ClientOption
  • func WithTimeoutMs(timeoutMs uint64) ClientOption
  • func WithUpdateCacheWhenEmpty(updateCacheWhenEmpty bool) ClientOption
  • func WithUpdateThreadNum(updateThreadNum int) ClientOption
  • func WithUsername(username string) ClientOption
• type ServerConfig
  • func NewServerConfig(ipAddr string, port uint64, opts ...ServerOption) *ServerConfig
• type ServerOption
  • func WithContextPath(contextPath string) ServerOption
  • func WithIpAddr(ipAddr string) ServerOption
  • func WithPort(port uint64) ServerOption
  • func WithScheme(scheme string) ServerOption

Constants

const (
	KEY_USERNAME                = "username"
	KEY_PASSWORD                = "password"
	KEY_ENDPOINT                = "endpoint"
	KEY_NAME_SPACE              = "namespace"
	KEY_ACCESS_KEY              = "accessKey"
	KEY_SECRET_KEY              = "secretKey"
	KEY_SERVER_ADDR             = "serverAddr"
	KEY_CONTEXT_PATH            = "contextPath"
	KEY_ENCODE                  = "encode"
	KEY_DATA_ID                 = "dataId"
	KEY_GROUP                   = "group"
	KEY_TENANT                  = "tenant"
	KEY_DESC                    = "desc"
	KEY_APP_NAME                = "appName"
	KEY_CONTENT                 = "content"
	KEY_TIMEOUT_MS              = "timeoutMs"
	KEY_LISTEN_INTERVAL         = "listenInterval"
	KEY_SERVER_CONFIGS          = "serverConfigs"
	KEY_CLIENT_CONFIG           = "clientConfig"
	KEY_TOKEN                   = "token"
	KEY_ACCESS_TOKEN            = "accessToken"
	KEY_TOKEN_TTL               = "tokenTtl"
	KEY_GLOBAL_ADMIN            = "globalAdmin"
	KEY_TOKEN_REFRESH_WINDOW    = "tokenRefreshWindow"
	WEB_CONTEXT                 = "/nacos"
	CONFIG_BASE_PATH            = "/v1/cs"
	CONFIG_PATH                 = CONFIG_BASE_PATH + "/configs"
	CONFIG_AGG_PATH             = "/datum.do"
	CONFIG_LISTEN_PATH          = CONFIG_BASE_PATH + "/configs/listener"
	SERVICE_BASE_PATH           = "/v1/ns"
	SERVICE_PATH                = SERVICE_BASE_PATH + "/instance"
	SERVICE_INFO_PATH           = SERVICE_BASE_PATH + "/service"
	SERVICE_SUBSCRIBE_PATH      = SERVICE_PATH + "/list"
	NAMESPACE_PATH              = "/v1/console/namespaces"
	CATALOG_PATH                = "/v1/ns/catalog"
	CATALOG_SERVICE_PATH        = CATALOG_PATH + "/services"
	SPLIT_CONFIG                = string(rune(1))
	SPLIT_CONFIG_INNER          = string(rune(2))
	KEY_LISTEN_CONFIGS          = "Listening-Configs"
	KEY_SERVICE_NAME            = "serviceName"
	KEY_IP                      = "ip"
	KEY_PORT                    = "port"
	KEY_WEIGHT                  = "weight"
	KEY_ENABLE                  = "enable"
	KEY_HEALTHY                 = "healthy"
	KEY_METADATA                = "metadata"
	KEY_CLUSTER_NAME            = "clusterName"
	KEY_CLUSTER                 = "cluster"
	KEY_BEAT                    = "beat"
	KEY_DOM                     = "dom"
	DEFAULT_CONTEXT_PATH        = "/nacos"
	CLIENT_VERSION              = "Nacos-Go-Client:v1.1.4"
	REQUEST_DOMAIN_RETRY_TIME   = 3
	SERVICE_INFO_SPLITER        = "@@"
	CONFIG_INFO_SPLITER         = "@@"
	DEFAULT_NAMESPACE_ID        = "public"
	DEFAULT_GROUP               = "DEFAULT_GROUP"
	NAMING_INSTANCE_ID_SPLITTER = "#"
	DefaultClientErrorCode      = "SDK.NacosError"
	DEFAULT_SERVER_SCHEME       = "http"
	WINDOWS_LEGAL_NAME_SPLITER  = "&&"
	OS_WINDOWS                  = "windows"
	LOG_FILE_NAME               = "nacos-sdk.log"
)

const (
	HEART_BEAT_TIMEOUT  = "preserved.heart.beat.timeout"
	IP_DELETE_TIMEOUT   = "preserved.ip.delete.timeout"
	HEART_BEAT_INTERVAL = "preserved.heart.beat.interval"
)

Types

type ClientConfig

type ClientConfig struct {
	TimeoutMs            uint64                 // timeout for requesting Nacos server, default value is 10000ms
	ListenInterval       uint64                 // Deprecated
	BeatInterval         int64                  // the time interval for sending beat to server,default value is 5000ms
	NamespaceId          string                 // the namespaceId of Nacos.When namespace is public, fill in the blank string here.
	AppName              string                 // the appName
	Endpoint             string                 // the endpoint for get Nacos server addresses
	RegionId             string                 // the regionId for kms
	AccessKey            string                 // the AccessKey for kms
	SecretKey            string                 // the SecretKey for kms
	OpenKMS              bool                   // it's to open kms,default is false. https://help.aliyun.com/product/28933.html
	CacheDir             string                 // the directory for persist nacos service info,default value is current path
	UpdateThreadNum      int                    // the number of gorutine for update nacos service info,default value is 20
	NotLoadCacheAtStart  bool                   // not to load persistent nacos service info in CacheDir at start time
	UpdateCacheWhenEmpty bool                   // update cache when get empty service instance from server
	Username             string                 // the username for nacos auth
	Password             string                 // the password for nacos auth
	LogDir               string                 // the directory for log, default is current path
	LogLevel             string                 // the level of log, it's must be debug,info,warn,error, default value is info
	LogSampling          *logger.SamplingConfig // the sampling config of log
	ContextPath          string                 // the nacos server contextpath
	LogRollingConfig     *lumberjack.Logger     // the log rolling config
	CustomLogger         logger.Logger          // the custom log interface ,With a custom Logger (nacos sdk will not provide log cutting and archiving capabilities)
	AppendToStdout       bool                   // append log to stdout
}

func NewClientConfig

func NewClientConfig(opts ...ClientOption) *ClientConfig

type ClientOption

type ClientOption func(*ClientConfig)

ClientOption ...

func WithAccessKey

func WithAccessKey(accessKey string) ClientOption

WithAccessKey ...

func WithBeatInterval

func WithBeatInterval(beatInterval int64) ClientOption

WithBeatInterval ...

func WithCacheDir

func WithCacheDir(cacheDir string) ClientOption

WithCacheDir ...

func WithCustomLogger

func WithCustomLogger(logger logger.Logger) ClientOption

WithCustomLogger ...

func WithEndpoint

func WithEndpoint(endpoint string) ClientOption

WithEndpoint ...

func WithLogDir

func WithLogDir(logDir string) ClientOption

WithLogDir ...

func WithLogLevel

func WithLogLevel(logLevel string) ClientOption

WithLogLevel ...

func WithLogRollingConfig

func WithLogRollingConfig(rollingConfig *lumberjack.Logger) ClientOption

WithLogRollingConfig ...

func WithLogSampling

func WithLogSampling(tick time.Duration, initial int, thereafter int) ClientOption

WithLogSampling ...

func WithLogStdout

func WithLogStdout(logStdout bool) ClientOption

WithLogStdout ...

func WithNamespaceId

func WithNamespaceId(namespaceId string) ClientOption

WithNamespaceId ...

func WithNotLoadCacheAtStart

func WithNotLoadCacheAtStart(notLoadCacheAtStart bool) ClientOption

WithNotLoadCacheAtStart ...

func WithOpenKMS

func WithOpenKMS(openKMS bool) ClientOption

WithOpenKMS ...

func WithPassword

func WithPassword(password string) ClientOption

WithPassword ...

func WithRegionId

func WithRegionId(regionId string) ClientOption

WithRegionId ...

func WithSecretKey

func WithSecretKey(secretKey string) ClientOption

WithSecretKey ...

func WithTimeoutMs

func WithTimeoutMs(timeoutMs uint64) ClientOption

WithTimeoutMs ...

func WithUpdateCacheWhenEmpty

func WithUpdateCacheWhenEmpty(updateCacheWhenEmpty bool) ClientOption

WithUpdateCacheWhenEmpty ...

func WithUpdateThreadNum

func WithUpdateThreadNum(updateThreadNum int) ClientOption

WithUpdateThreadNum ...

func WithUsername

func WithUsername(username string) ClientOption

WithUsername ...

type ServerConfig

type ServerConfig struct {
	Scheme      string //the nacos server scheme
	ContextPath string //the nacos server contextpath
	IpAddr      string //the nacos server address
	Port        uint64 //the nacos server port
}

func NewServerConfig

func NewServerConfig(ipAddr string, port uint64, opts ...ServerOption) *ServerConfig

type ServerOption

type ServerOption func(*ServerConfig)

ServerOption ...

func WithContextPath

func WithContextPath(contextPath string) ServerOption

WithContextPath set contextPath for server

func WithIpAddr

func WithIpAddr(ipAddr string) ServerOption

WithIpAddr set ip address for server

func WithPort

func WithPort(port uint64) ServerOption

WithPort set port for server

func WithScheme

func WithScheme(scheme string) ServerOption

WithScheme set Scheme for server