constant

Documentation

Index

• Constants
• Variables
• type DubboCtxKey

Constants

const (
	FAILOVER_CLUSTER_NAME  = "failover"
	ZONEAWARE_CLUSTER_NAME = "zoneAware"
)

nolint

const (
	DUBBO             = "dubbo"
	PROVIDER_PROTOCOL = "provider"
	//compatible with 2.6.x
	OVERRIDE_PROTOCOL = "override"
	EMPTY_PROTOCOL    = "empty"
	ROUTER_PROTOCOL   = "router"
)

const (
	DEFAULT_WEIGHT = 100     //
	DEFAULT_WARMUP = 10 * 60 // in java here is 10*60*1000 because of System.currentTimeMillis() is measured in milliseconds & in go time.Unix() is second
)

const (
	DEFAULT_LOADBALANCE        = "random"
	DEFAULT_RETRIES            = "2"
	DEFAULT_RETRIES_INT        = 2
	DEFAULT_PROTOCOL           = "dubbo"
	DEFAULT_REG_TIMEOUT        = "10s"
	DEFAULT_REG_TTL            = "15m"
	DEFAULT_CLUSTER            = "failover"
	DEFAULT_FAILBACK_TIMES     = "3"
	DEFAULT_FAILBACK_TIMES_INT = 3
	DEFAULT_FAILBACK_TASKS     = 100
	DEFAULT_REST_CLIENT        = "resty"
	DEFAULT_REST_SERVER        = "go-restful"
	DEFAULT_PORT               = 20000
	DEFAULT_SERIALIZATION      = HESSIAN2_SERIALIZATION
	DEFAULT_PARAM_TIME         = 3 * time.Second
)

const (
	DEFAULT_KEY               = "default"
	PREFIX_DEFAULT_KEY        = "default."
	DEFAULT_SERVICE_FILTERS   = "echo,token,accesslog,tps,generic_service,execute,pshutdown"
	DEFAULT_REFERENCE_FILTERS = "cshutdown"
	GENERIC_REFERENCE_FILTERS = "generic"
	GENERIC                   = "$invoke"
	GENERIC_ASYNC             = "$invokeAsync"
	ECHO                      = "$echo"
)

const (
	ANY_VALUE           = "*"
	ANYHOST_VALUE       = "0.0.0.0"
	LOCAL_HOST_VALUE    = "192.168.1.1"
	REMOVE_VALUE_PREFIX = "-"
)

const (
	CONFIGURATORS_CATEGORY             = "configurators"
	DYNAMIC_CONFIGURATORS_CATEGORY     = "dynamicconfigurators"
	APP_DYNAMIC_CONFIGURATORS_CATEGORY = "appdynamicconfigurators"
	DEFAULT_CATEGORY                   = PROVIDER_CATEGORY
	PROVIDER_CATEGORY                  = "providers"
	CONSUMER_CATEGORY                  = "consumers"
	ROUTER_CATEGORY                    = "routers"
)

const (
	SIMPLE_METADATA_SERVICE_NAME = "MetadataService"
	DEFAULT_REVISION             = "N/A"
)

const (
	// CONF_CONSUMER_FILE_PATH ...
	CONF_CONSUMER_FILE_PATH = "CONF_CONSUMER_FILE_PATH"
	// CONF_PROVIDER_FILE_PATH ...
	CONF_PROVIDER_FILE_PATH = "CONF_PROVIDER_FILE_PATH"
	// APP_LOG_CONF_FILE ...
	APP_LOG_CONF_FILE = "APP_LOG_CONF_FILE"
	// CONF_ROUTER_FILE_PATH Specify Path variable of router config file
	CONF_ROUTER_FILE_PATH = "CONF_ROUTER_FILE_PATH"
)

nolint

const (
	GROUP_KEY                = "group"
	VERSION_KEY              = "version"
	INTERFACE_KEY            = "interface"
	MESSAGE_SIZE_KEY         = "message_size"
	PATH_KEY                 = "path"
	SERVICE_KEY              = "service"
	METHODS_KEY              = "methods"
	TIMEOUT_KEY              = "timeout"
	CATEGORY_KEY             = "category"
	CHECK_KEY                = "check"
	ENABLED_KEY              = "enabled"
	SIDE_KEY                 = "side"
	OVERRIDE_PROVIDERS_KEY   = "providerAddresses"
	BEAN_NAME_KEY            = "bean.name"
	GENERIC_KEY              = "generic"
	CLASSIFIER_KEY           = "classifier"
	TOKEN_KEY                = "token"
	LOCAL_ADDR               = "local-addr"
	REMOTE_ADDR              = "remote-addr"
	DEFAULT_REMOTING_TIMEOUT = 3000
	RELEASE_KEY              = "release"
	ANYHOST_KEY              = "anyhost"
	PORT_KEY                 = "port"
	PROTOCOL_KEY             = "protocol"
	PATH_SEPARATOR           = "/"
	SSL_ENABLED_KEY          = "ssl-enabled"
	DEFAULT_KEY_PREFIX       = "default."
)

const (
	SERVICE_FILTER_KEY   = "service.filter"
	REFERENCE_FILTER_KEY = "reference.filter"
)

const (
	TIMESTAMP_KEY                          = "timestamp"
	REMOTE_TIMESTAMP_KEY                   = "remote.timestamp"
	CLUSTER_KEY                            = "cluster"
	LOADBALANCE_KEY                        = "loadbalance"
	WEIGHT_KEY                             = "weight"
	WARMUP_KEY                             = "warmup"
	RETRIES_KEY                            = "retries"
	STICKY_KEY                             = "sticky"
	BEAN_NAME                              = "bean.name"
	FAIL_BACK_TASKS_KEY                    = "failbacktasks"
	FORKS_KEY                              = "forks"
	DEFAULT_FORKS                          = 2
	DEFAULT_TIMEOUT                        = 1000
	ACCESS_LOG_KEY                         = "accesslog"
	TPS_LIMITER_KEY                        = "tps.limiter"
	TPS_REJECTED_EXECUTION_HANDLER_KEY     = "tps.limit.rejected.handler"
	TPS_LIMIT_RATE_KEY                     = "tps.limit.rate"
	DEFAULT_TPS_LIMIT_RATE                 = "-1"
	TPS_LIMIT_INTERVAL_KEY                 = "tps.limit.interval"
	DEFAULT_TPS_LIMIT_INTERVAL             = "60000"
	TPS_LIMIT_STRATEGY_KEY                 = "tps.limit.strategy"
	EXECUTE_LIMIT_KEY                      = "execute.limit"
	DEFAULT_EXECUTE_LIMIT                  = "-1"
	EXECUTE_REJECTED_EXECUTION_HANDLER_KEY = "execute.limit.rejected.handler"
	PROVIDER_SHUTDOWN_FILTER               = "pshutdown"
	CONSUMER_SHUTDOWN_FILTER               = "cshutdown"
	SERIALIZATION_KEY                      = "serialization"
	PID_KEY                                = "pid"
	SYNC_REPORT_KEY                        = "sync.report"
	RETRY_PERIOD_KEY                       = "retry.period"
	RETRY_TIMES_KEY                        = "retry.times"
	CYCLE_REPORT_KEY                       = "cycle.report"
	DEFAULT_BLACK_LIST_RECOVER_BLOCK       = 64
	DEFAULT_BLACK_LIST_MAX_RETRY_TIMES     = 512
)

const (
	REGISTRY_KEY         = "registry"
	REGISTRY_PROTOCOL    = "registry"
	ROLE_KEY             = "registry.role"
	REGISTRY_DEFAULT_KEY = "registry.default"
	REGISTRY_TIMEOUT_KEY = "registry.timeout"
	REGISTRY_LABEL_KEY   = "label"
	PREFERRED_KEY        = "preferred"
	ZONE_KEY             = "zone"
	ZONE_FORCE_KEY       = "zone.force"
	REGISTRY_TTL_KEY     = "registry.ttl"
	REGISTRY_GROUP_KEY   = "registry.group"
)

const (
	APPLICATION_KEY          = "application"
	ORGANIZATION_KEY         = "organization"
	NAME_KEY                 = "name"
	MODULE_KEY               = "module"
	APP_VERSION_KEY          = "app.version"
	OWNER_KEY                = "owner"
	ENVIRONMENT_KEY          = "environment"
	METHOD_KEY               = "method"
	METHOD_KEYS              = "methods"
	RULE_KEY                 = "rule"
	RUNTIME_KEY              = "runtime"
	BACKUP_KEY               = "backup"
	ROUTERS_CATEGORY         = "routers"
	ROUTE_PROTOCOL           = "route"
	CONDITION_ROUTE_PROTOCOL = "condition"
	TAG_ROUTE_PROTOCOL       = "tag"
	PROVIDERS_CATEGORY       = "providers"
	CONSUMERS_CATEGORY       = "consumers"
	ROUTER_KEY               = "router"
	EXPORT_KEY               = "export"
)

const (
	CONFIG_NAMESPACE_KEY  = "namespace"
	CONFIG_GROUP_KEY      = "group"
	CONFIG_APP_ID_KEY     = "appId"
	CONFIG_CLUSTER_KEY    = "cluster"
	CONFIG_TIMEOUT_KEY    = "timeout"
	CONFIG_USERNAME_KEY   = "username"
	CONFIG_PASSWORD_KEY   = "password"
	CONFIG_LOG_DIR_KEY    = "logDir"
	CONFIG_VERSION_KEY    = "configVersion"
	COMPATIBLE_CONFIG_KEY = "compatible_config"
)

const (
	RegistryConfigPrefix       = "dubbo.registries."
	SingleRegistryConfigPrefix = "dubbo.registry."
	ReferenceConfigPrefix      = "dubbo.reference."
	ServiceConfigPrefix        = "dubbo.service."
	ConfigBasePrefix           = "dubbo.base."
	RemotePrefix               = "dubbo.remote."
	ServiceDiscPrefix          = "dubbo.service-discovery."
	ProtocolConfigPrefix       = "dubbo.protocols."
	ProviderConfigPrefix       = "dubbo.provider."
	ConsumerConfigPrefix       = "dubbo.consumer."
	ShutdownConfigPrefix       = "dubbo.shutdown."
	MetadataReportPrefix       = "dubbo.metadata-report."
	RouterConfigPrefix         = "dubbo.router."
)

const (
	NACOS_KEY                         = "nacos"
	NACOS_DEFAULT_ROLETYPE            = 3
	NACOS_CACHE_DIR_KEY               = "cacheDir"
	NACOS_LOG_DIR_KEY                 = "logDir"
	NACOS_BEAT_INTERVAL_KEY           = "beatInterval"
	NACOS_ENDPOINT                    = "endpoint"
	NACOS_SERVICE_NAME_SEPARATOR      = ":"
	NACOS_CATEGORY_KEY                = "category"
	NACOS_PROTOCOL_KEY                = "protocol"
	NACOS_PATH_KEY                    = "path"
	NACOS_NAMESPACE_ID                = "namespaceId"
	NACOS_PASSWORD                    = "password"
	NACOS_USERNAME                    = "username"
	NACOS_NOT_LOAD_LOCAL_CACHE        = "nacos.not.load.cache"
	NACOS_APP_NAME_KEY                = "appName"
	NACOS_REGION_ID_KEY               = "regionId"
	NACOS_ACCESS_KEY                  = "access"
	NACOS_SECRET_KEY                  = "secret"
	NACOS_OPEN_KMS_KEY                = "kms"
	NACOS_UPDATE_THREAD_NUM_KEY       = "updateThreadNum"
	NACOS_LOG_LEVEL_KEY               = "logLevel"
	NACOS_Update_Cache_When_Empty_KEY = "updateCacheWhenEmpty"
	NACOS_LOG_MAX_AGE_KEY             = "maxAge"
	NACOS_LOG_Rotate_Time_KEY         = "rotateTime"
)

const (
	CONSUL_KEY          = "consul"
	CHECK_PASS_INTERVAL = "consul-check-pass-interval"
	// default time-to-live in millisecond
	DEFAULT_CHECK_PASS_INTERVAL = 16000
	QUERY_TAG                   = "consul_query_tag"
	ACL_TOKEN                   = "acl-token"
	// default deregister critical server after
	DEFAULT_DEREGISTER_TIME = "20s"
	DEREGISTER_AFTER        = "consul-deregister-critical-service-after"
)

const (
	// ConditionRouterName Specify file condition router name
	ConditionRouterName = "condition"
	// ConditionAppRouterName Specify listenable application router name
	ConditionAppRouterName = "app"
	// ListenableRouterName Specify listenable router name
	ListenableRouterName = "listenable"
	// HealthCheckRouterName Specify the name of HealthCheckRouter
	HealthCheckRouterName = "health_check"
	// LocalPriorityRouterName Specify the name of LocalPriorityRouter
	LocalPriorityRouterName = "local_priority"
	// ConnCheckRouterName Specify the name of ConnCheckRouter
	ConnCheckRouterName = "conn_check"
	// TagRouterName Specify the name of TagRouter
	TagRouterName = "tag"
	// TagRouterRuleSuffix Specify tag router suffix
	TagRouterRuleSuffix  = ".tag-router"
	RemoteApplicationKey = "remote.application"
	// ConditionRouterRuleSuffix Specify condition router suffix
	ConditionRouterRuleSuffix = ".condition-router"

	// Force Force key in router module
	RouterForce = "force"
	// Enabled Enabled key in router module
	RouterEnabled = "enabled"
	// Priority Priority key in router module
	RouterPriority = "priority"
	// RouterScope Scope key in router module
	RouterScope = "scope"
	// RouterApplicationScope Scope key in router module
	RouterApplicationScope = "application"
	// RouterServiceScope Scope key in router module
	RouterServiceScope = "service"
	// RouterRuleKey defines the key of the router, service's/application's name
	RouterRuleKey = "key"
	// ForceUseTag is the tag in attachment
	ForceUseTag = "dubbo.force.tag"
	Tagkey      = "dubbo.tag"
	// HEALTH_ROUTE_ENABLED_KEY defines if use health router
	HEALTH_ROUTE_ENABLED_KEY = "health.route.enabled"
	// AttachmentKey in context in invoker
	AttachmentKey = DubboCtxKey("attachment")
)

Use for router module

const (
	// name of consumer sign filter
	CONSUMER_SIGN_FILTER = "sign"
	// name of consumer sign filter
	PROVIDER_AUTH_FILTER = "auth"
	// name of service filter
	SERVICE_AUTH_KEY = "auth"
	// key of authenticator
	AUTHENTICATOR_KEY = "authenticator"
	// name of default authenticator
	DEFAULT_AUTHENTICATOR = "accesskeys"
	// name of default url storage
	DEFAULT_ACCESS_KEY_STORAGE = "urlstorage"
	// key of storage
	ACCESS_KEY_STORAGE_KEY = "accessKey.storage"
	// key of request timestamp
	REQUEST_TIMESTAMP_KEY = "timestamp"
	// key of request signature
	REQUEST_SIGNATURE_KEY = "signature"
	// AK key
	AK_KEY = "ak"
	// signature format
	SIGNATURE_STRING_FORMAT = "%s#%s#%s#%s"
	// key whether enable signature
	PARAMETER_SIGNATURE_ENABLE_KEY = "param.sign"
	// consumer
	CONSUMER = "consumer"
	// key of access key id
	ACCESS_KEY_ID_KEY = ".accessKeyId"
	// key of secret access key
	SECRET_ACCESS_KEY_KEY = ".secretAccessKey"
)

const (
	METACONFIG_REMOTE  = "remote"
	METACONFIG_LOCAL   = "local"
	KEY_SEPARATOR      = ":"
	DEFAULT_PATH_TAG   = "metadata"
	KEY_REVISON_PREFIX = "revision"

	// metadata service
	METADATA_SERVICE_NAME = "org.apache.dubbo.metadata.MetadataService"
)

const (
	// The key of HealthCheck SPI
	HEALTH_CHECKER = "health.checker"
	// The name of the default implementation of HealthChecker
	DEFAULT_HEALTH_CHECKER = "default"
	// The name of the default implementation of C
	DEFAULT_CONN_CHECKER = "default"
	// The key of outstanding-request-limit\
	OUTSTANDING_REQUEST_COUNT_LIMIT_KEY = "outstanding.request.limit"
	// The key of successive-failed-request's threshold
	SUCCESSIVE_FAILED_REQUEST_THRESHOLD_KEY = "successive.failed.threshold"
	// The key of circuit-tripped timeout factor
	CIRCUIT_TRIPPED_TIMEOUT_FACTOR_KEY = "circuit.tripped.timeout.factor"
	// The default threshold of  successive-failed-request if not specfied
	DEFAULT_SUCCESSIVE_FAILED_THRESHOLD = 5
	// The default maximum diff between successive-failed-request's threshold and actual successive-failed-request's count
	DEFAULT_SUCCESSIVE_FAILED_REQUEST_MAX_DIFF = 5
	// The default factor of  circuit-tripped timeout if not specfied
	DEFAULT_CIRCUIT_TRIPPED_TIMEOUT_FACTOR = 1000
	// The default time window of circuit-tripped  in millisecond if not specfied
	MAX_CIRCUIT_TRIPPED_TIMEOUT_IN_MS = 30000
)

HealthCheck Router

const (
	SUBSCRIBED_SERVICE_NAMES_KEY               = "subscribed-services"
	PROVIDER_BY                                = "provided-by"
	EXPORTED_SERVICES_REVISION_PROPERTY_NAME   = "dubbo.exported-services.revision"
	SUBSCRIBED_SERVICES_REVISION_PROPERTY_NAME = "dubbo.subscribed-services.revision"
	SERVICE_INSTANCE_SELECTOR                  = "service-instance-selector"
	METADATA_STORAGE_TYPE_PROPERTY_NAME        = "dubbo.metadata.storage-type"
	DEFAULT_METADATA_STORAGE_TYPE              = "local"
	SERVICE_INSTANCE_ENDPOINTS                 = "dubbo.endpoints"
	METADATA_SERVICE_PREFIX                    = "dubbo.metadata-service."
	METADATA_SERVICE_URL_PARAMS_PROPERTY_NAME  = METADATA_SERVICE_PREFIX + "url-params"
	METADATA_SERVICE_URLS_PROPERTY_NAME        = METADATA_SERVICE_PREFIX + "urls"

	// SERVICE_DISCOVERY_KEY indicate which service discovery instance will be used
	SERVICE_DISCOVERY_KEY = "service_discovery"
)

service discovery

const (
	HookEventBeforeReferenceConnect  = "before-reference-connect"
	HookEventReferenceConnectSuccess = "reference-connect-success"
	HookEventReferenceConnectFail    = "reference-connect-fail"

	HookEventBeforeServiceListen  = "before-service-listen"
	HookEventServiceListenSuccess = "service-listen-success"
	HookEventServiceListenFail    = "service-listen-fail"

	LoadProcessReferenceConfigFunctionName        = "LoadProcessReferenceConfig"
	LoadProcessServiceConfigFunctionName          = "LoadProcessServiceConfig"
	AfterAllReferencesConnectCompleteFunctionName = "AfterAllReferencesConnectComplete"
	AfterAllServicesListenCompleteFunctionName    = "AfterAllServicesListenComplete"
	BeforeShutdownFunctionName                    = "BeforeShutdown"
)

Loader Hook

const (
	S_Hessian2 byte = 2
	S_Proto    byte = 21
)

const (
	HESSIAN2_SERIALIZATION = "hessian2"
	PROTOBUF_SERIALIZATION = "protobuf"
)

const (
	// Version apache/dubbo-go version
	Version = "1.5.8"
	// Name module name
	Name = "dubbogo"
	// Date release date
	DATE = "2022/05/03"
)

const (
	ASYNC_KEY = "async" // it's value should be "true" or "false" of string type
)

const (
	COMMA_SPLIT_PATTERN = "\\s*[,]+\\s*"
)

const (
	CONFIGURATORS_SUFFIX = ".configurators"
)

const (
	DUBBOGO_CTX_KEY = DubboCtxKey("dubbogo-ctx")
)

const (
	DefaultProtocolPayload = 8388608
)

const (
	ETCDV3_KEY = "etcdv3"
)

const (
	FILE_KEY = "file"
)

const (
	ProtocolPayload = "protocol.payload"
)

protocol config

const (
	SERVICE_DISCOVERY_DEFAULT_GROUP = "DEFAULT_GROUP"
)

const (
	TRACING_REMOTE_SPAN_CTX = DubboCtxKey("tracing.remote.span.ctx")
)

const (
	ZOOKEEPER_KEY = "zookeeper"
)

Variables

var (
	DefaultProtocolPayloadStr = strconv.Itoa(DefaultProtocolPayload)
)

var (
	// The value will be 10^6
	// 1ms = 10^6ns
	MsToNanoRate = int64(time.Millisecond / time.Nanosecond)
)

Types

type DubboCtxKey

type DubboCtxKey string