Documentation
¶
Index ¶
- func NewSDKContext() (api.SDKContext, error)
- func NewSDKContextByAddress(address ...string) (api.SDKContext, error)
- func NewSDKContextByConfig(cfg config.Configuration) (api.SDKContext, error)
- type ConfigAPI
- type ConfigFile
- type ConsumerAPI
- func NewConsumerAPI() (ConsumerAPI, error)
- func NewConsumerAPIByAddress(address ...string) (ConsumerAPI, error)
- func NewConsumerAPIByConfig(cfg config.Configuration) (ConsumerAPI, error)
- func NewConsumerAPIByContext(context api.SDKContext) ConsumerAPI
- func NewConsumerAPIByFile(path string) (ConsumerAPI, error)
- type GetAllInstancesRequest
- type GetInstancesRequest
- type GetOneInstanceRequest
- type GetServiceRuleRequest
- type GetServicesRequest
- type InitCalleeServiceRequest
- type InstanceDeRegisterRequest
- type InstanceHeartbeatRequest
- type InstanceRegisterRequest
- type LimitAPI
- type ProcessLoadBalanceRequest
- type ProcessRoutersRequest
- type ProviderAPI
- func NewProviderAPI() (ProviderAPI, error)
- func NewProviderAPIByAddress(address ...string) (ProviderAPI, error)
- func NewProviderAPIByConfig(cfg config.Configuration) (ProviderAPI, error)
- func NewProviderAPIByContext(context api.SDKContext) ProviderAPI
- func NewProviderAPIByFile(path string) (ProviderAPI, error)
- type QuotaFuture
- type QuotaRequest
- type RouterAPI
- type ServiceCallResult
- type WatchServiceRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewSDKContext ¶ added in v1.2.0
func NewSDKContext() (api.SDKContext, error)
func NewSDKContextByAddress ¶ added in v1.2.0
func NewSDKContextByAddress(address ...string) (api.SDKContext, error)
func NewSDKContextByConfig ¶ added in v1.2.0
func NewSDKContextByConfig(cfg config.Configuration) (api.SDKContext, error)
Types ¶
type ConfigAPI ¶
type ConfigAPI interface {
api.SDKOwner
// GetConfigFile 获取配置文件
GetConfigFile(namespace, fileGroup, fileName string) (ConfigFile, error)
}
ConfigAPI 配置文件的 API
func NewConfigAPIByConfig ¶
func NewConfigAPIByConfig(cfg config.Configuration) (ConfigAPI, error)
NewConfigAPIByConfig 通过配置对象获取配置中心 API
func NewConfigAPIByContext ¶
func NewConfigAPIByContext(context api.SDKContext) ConfigAPI
NewConfigAPIByContext 通过上下文对象获取配置中心 API
func NewConfigAPIByFile ¶
NewConfigAPIByFile 通过配置文件获取配置中心 API
type ConfigFile ¶
type ConfigFile model.ConfigFile
type ConsumerAPI ¶
type ConsumerAPI interface {
api.SDKOwner
// GetOneInstance 同步获取单个服务
GetOneInstance(req *GetOneInstanceRequest) (*model.OneInstanceResponse, error)
// GetInstances 同步获取可用的服务列表
GetInstances(req *GetInstancesRequest) (*model.InstancesResponse, error)
// GetAllInstances 同步获取完整的服务列表
GetAllInstances(req *GetAllInstancesRequest) (*model.InstancesResponse, error)
// GetRouteRule 同步获取服务路由规则
GetRouteRule(req *GetServiceRuleRequest) (*model.ServiceRuleResponse, error)
// UpdateServiceCallResult 上报服务调用结果
UpdateServiceCallResult(req *ServiceCallResult) error
// WatchService 订阅服务消息
WatchService(req *WatchServiceRequest) (*model.WatchServiceResponse, error)
// GetServicesByBusiness 根据业务同步获取批量服务
GetServicesByBusiness(req *GetServicesRequest) (*model.ServicesResponse, error)
// InitCalleeService 初始化服务运行中需要的被调服务
InitCalleeService(req *InitCalleeServiceRequest) error
// Destroy 销毁API,销毁后无法再进行调用
Destroy()
}
ConsumerAPI 主调端API方法
func NewConsumerAPI ¶
func NewConsumerAPI() (ConsumerAPI, error)
func NewConsumerAPIByAddress ¶
func NewConsumerAPIByAddress(address ...string) (ConsumerAPI, error)
func NewConsumerAPIByConfig ¶
func NewConsumerAPIByConfig(cfg config.Configuration) (ConsumerAPI, error)
func NewConsumerAPIByContext ¶
func NewConsumerAPIByContext(context api.SDKContext) ConsumerAPI
func NewConsumerAPIByFile ¶
func NewConsumerAPIByFile(path string) (ConsumerAPI, error)
type GetAllInstancesRequest ¶
type GetAllInstancesRequest api.GetAllInstancesRequest
type GetInstancesRequest ¶
type GetInstancesRequest api.GetInstancesRequest
type GetServiceRuleRequest ¶
type GetServiceRuleRequest api.GetServiceRuleRequest
type GetServicesRequest ¶
type GetServicesRequest api.GetServicesRequest
type InitCalleeServiceRequest ¶
type InitCalleeServiceRequest api.InitCalleeServiceRequest
type InstanceDeRegisterRequest ¶
type InstanceDeRegisterRequest api.InstanceDeRegisterRequest
type InstanceHeartbeatRequest ¶
type InstanceHeartbeatRequest api.InstanceHeartbeatRequest
type LimitAPI ¶
type LimitAPI interface {
api.SDKOwner
// GetQuota 获取限流配额,一次接口只获取一个配额
GetQuota(request QuotaRequest) (QuotaFuture, error)
// Destroy 销毁API,销毁后无法再进行调用
Destroy()
}
LimitAPI 限流相关的API相关接口
func NewLimitAPIByAddress ¶
func NewLimitAPIByConfig ¶
func NewLimitAPIByConfig(cfg config.Configuration) (LimitAPI, error)
NewLimitAPIByConfig 通过配置对象创建SDK LimitAPI对象
func NewLimitAPIByContext ¶
func NewLimitAPIByContext(context api.SDKContext) LimitAPI
NewLimitAPIByContext 通过上下文创建SDK LimitAPI对象
func NewLimitAPIByFile ¶
NewLimitAPIByFile 通过配置文件创建SDK LimitAPI对象
type ProcessLoadBalanceRequest ¶ added in v1.2.0
type ProcessLoadBalanceRequest struct {
model.ProcessLoadBalanceRequest
}
type ProcessRoutersRequest ¶ added in v1.2.0
type ProcessRoutersRequest struct {
model.ProcessRoutersRequest
}
type ProviderAPI ¶
type ProviderAPI interface {
api.SDKOwner
// Register
// 同步注册服务,服务注册成功后会填充instance中的InstanceID字段
// 用户可保持该instance对象用于反注册和心跳上报
Register(instance *InstanceRegisterRequest) (*model.InstanceRegisterResponse, error)
// Deregister
// 同步反注册服务
Deregister(instance *InstanceDeRegisterRequest) error
// Heartbeat
// 心跳上报
Heartbeat(instance *InstanceHeartbeatRequest) error
// Destroy
// 销毁API,销毁后无法再进行调用
Destroy()
}
ProviderAPI CL5服务端API的主接口
func NewProviderAPI ¶
func NewProviderAPI() (ProviderAPI, error)
NewProviderAPI 通过以默认域名为埋点server的默认配置创建ProviderAPI
func NewProviderAPIByAddress ¶
func NewProviderAPIByAddress(address ...string) (ProviderAPI, error)
NewProviderAPIByAddress 通过address创建ProviderAPI
func NewProviderAPIByConfig ¶
func NewProviderAPIByConfig(cfg config.Configuration) (ProviderAPI, error)
NewProviderAPIByConfig 通过配置对象创建SDK ProviderAPI对象
func NewProviderAPIByContext ¶
func NewProviderAPIByContext(context api.SDKContext) ProviderAPI
NewProviderAPIByContext 通过上下文创建SDK ProviderAPI对象
func NewProviderAPIByFile ¶
func NewProviderAPIByFile(path string) (ProviderAPI, error)
NewProviderAPIByFile 通过配置文件创建SDK ProviderAPI对象
type QuotaFuture ¶
type QuotaFuture api.QuotaFuture
type RouterAPI ¶ added in v1.2.0
type RouterAPI interface {
api.SDKOwner
// process routers to filter instances
ProcessRouters(*ProcessRoutersRequest) (*model.InstancesResponse, error)
// process load balancer to get the target instances
ProcessLoadBalance(*ProcessLoadBalanceRequest) (*model.OneInstanceResponse, error)
}
RouterAPI 路由API方法
func NewRouterAPI ¶ added in v1.2.0
NewRouterAPI 通过以默认域名为埋点server的默认配置创建RouterAPI
func NewRouterAPIByAddress ¶ added in v1.2.0
NewRouterAPIByAddress 通过address创建RouterAPI
func NewRouterAPIByConfig ¶ added in v1.2.0
func NewRouterAPIByConfig(cfg config.Configuration) (RouterAPI, error)
newRouterAPIByConfig 通过配置对象创建SDK RouterAPI对象
func NewRouterAPIByContext ¶ added in v1.2.0
func NewRouterAPIByContext(context api.SDKContext) RouterAPI
NewRouterAPIByContext 通过上下文创建SDK RouterAPI对象
func NewRouterAPIByFile ¶ added in v1.2.0
NewProviderAPIByFile 通过配置文件创建SDK RouterAPI对象
type ServiceCallResult ¶
type ServiceCallResult api.ServiceCallResult
type WatchServiceRequest ¶
type WatchServiceRequest api.WatchServiceRequest
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
benchmark
|
|
|
benchmain
command
|
|
|
benchsimple
command
|
|
|
flags
Package flags provide convenience types and routines to accept specific types of flag values on the command line.
|
Package flags provide convenience types and routines to accept specific types of flag values on the command line. |
|
stats
Package stats tracks the statistics associated with benchmark runs.
|
Package stats tracks the statistics associated with benchmark runs. |
|
examples
|
|
|
activehealthcheck
command
|
|
|
circuitbreaker/consumer
command
|
|
|
circuitbreaker/provider
command
|
|
|
configuration
command
|
|
|
quickstart/consumer
command
|
|
|
quickstart/provider
command
|
|
|
ratelimit/consumer
command
|
|
|
ratelimit/provider
command
|
|
|
route/consumer
command
|
|
|
route/provider
command
|
|
|
pkg
|
|
|
model/pb/metric
Package metric is a generated protocol buffer package.
|
Package metric is a generated protocol buffer package. |
|
plugin
|
|
|
serverconnector/sidecar/client
* * Tencent is pleased to support the open source community by making polaris-go available.
|
* * Tencent is pleased to support the open source community by making polaris-go available. |
|
serverconnector/sidecar/dns
* * Tencent is pleased to support the open source community by making polaris-go available.
|
* * Tencent is pleased to support the open source community by making polaris-go available. |
|
serverconnector/sidecar/model/pb
Package pb is a generated protocol buffer package.
|
Package pb is a generated protocol buffer package. |
|
test
|
|
|
serviceroute
Package test mock test for set division * Tencent is pleased to support the open source community by making polaris-go available.
|
Package test mock test for set division * Tencent is pleased to support the open source community by making polaris-go available. |
|
tools
module
|