protoweb

type Config struct {
	Name                string                 `json:"name" toml:"name"`                                     // service name
	GrpcAddr            string                 `json:"grpc_addr" toml:"grpc_addr"`                           // grpc server listening address
	GrpcKeepAlive       time.Duration          `json:"grpc_keep_alive" toml:"grpc_keep_alive"`               // grpc server keep alive
	GrpcPlus            []string               `json:"grpc_plus" toml:"grpc_plus"`                           // ServerOption plugins for grpc server
	HttpAddr            string                 `json:"http_addr" toml:"http_addr"`                           // http server listening address
	HttpKeepAlive       time.Duration          `json:"http_keep_alive" toml:"http_keep_alive"`               // http server keep alive
	HttpCertFile        string                 `json:"http_cert_file" toml:"http_cert_file"`                 // http server TLS cert file
	HttpKeyFile         string                 `json:"http_key_file" toml:"http_key_file"`                   // http server TLS key file
	HttpMessageMaxLarge int64                  `json:"http_message_max_large" toml:"http_message_max_large"` // Multipart reader's max memory bytes. It returns ErrMessageTooLarge if all non-file parts can't be stored in memory. default 10 MB
	WbskReadBufferSize  int                    `json:"wbsk_read_buffer_size" toml:"wbsk_read_buffer_size"`   // websocket read buffer size
	WbskWriteBufferSize int                    `json:"wbsk_write_buffer_Size" toml:"wbsk_write_buffer_Size"` // websocket write buffer size
	WbskNotCheckOrigin  bool                   `json:"wbsk_not_check_origin" toml:"wbsk_not_check_origin"`   // websocket would not check origin
	HttpPlus            []string               `json:"http_plus" toml:"http_plus"`                           // HandlerFunc plugins for http server
	HttpRule            []*HttpRuleConfig      `json:"http_rule" toml:"http_rule"`                           // AccessRule for http server
	ProtoGrpcGate       int8                   `json:"proto_grpc_gate" toml:"proto_grpc_gate"`               // add grpc access for all service, default off(-1)
	ProtoPostGate       int8                   `json:"proto_post_gate" toml:"proto_post_gate"`               // add post access for all service/method, default off(-1)
	ProtoWbskGate       int8                   `json:"proto_wbsk_gate" toml:"proto_wbsk_gate"`               // add wbsk access for all service/method, default off(-1)
	ProtoOpenRule       []*ProtoOpenRuleConfig `json:"proto_open_rule" toml:"proto_open_rule"`               // more detail config for every service
	ProtoPackagePrefix  string                 `json:"proto_package_prefix" toml:"proto_package_prefix"`     // prefix of package should be trim
	ProtoPackageSuffix  string                 `json:"proto_package_suffix" toml:"proto_package_suffix"`     // suffix of package should be trim
	ProtoServicePrefix  string                 `json:"proto_service_prefix" toml:"proto_service_prefix"`     // prefix of service should be trim
	ProtoServiceSuffix  string                 `json:"proto_service_suffix" toml:"proto_service_suffix"`     // suffix of service should be trim
	ProtoMethodPrefix   string                 `json:"proto_method_prefix" toml:"proto_method_prefix"`       // prefix of method should be trim
	ProtoMethodSuffix   string                 `json:"proto_method_suffix" toml:"proto_method_suffix"`       // suffix of method should be trim
}

type Context struct {

	// 需要重置的属性
	ResponseWriter http.ResponseWriter
	Request        *http.Request
	// contains filtered or unexported fields
}

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

type GrpcPlusFunc interface {
	Call(args []string) grpc.ServerOption // 插件调用
}

type HandlerChain []HandlerFunc

type HandlerFunc func(ctx *Context)

type HttpNode struct {
	Package   string
	Service   string
	Method    string
	HttpGate  int8 // 是否关闭该规则
	Handlers  []HandlerFunc
	GroupPlus []HandlerFunc // 中间过程辅助属性:在router进行flattern时将group及父级以上的plus全部组装在此!
	RulesPlus []HandlerFunc // 中间过程辅助属性:来httprule处理时将httpRule的plus全部组装在此!
}

type HttpPathGenerator interface {
	Generate(grpcPackage, grpcService, grpcMethod, annotations string) string
}

type HttpPlusFunc interface {
	Call(args []string) HandlerFunc // 插件调用
}

type HttpRuleConfig struct {
	Package    string   `json:"package" toml:"package"`         // package from proto
	Service    string   `json:"service" toml:"service"`         // service from proto
	Method     string   `json:"method" toml:"method"`           // method from proto
	HttpGate   int8     `json:"http_gate" toml:"http_gate"`     // 是否关闭该规则
	HttpMethod string   `json:"http_method" toml:"http_method"` // http method
	HttpPath   string   `json:"http_path" toml:"http_path"`     // http path
	HttpPlus   []string `json:"http_plus" toml:"http_plus"`     // http plus
}

type HttpRuleOption interface {
	Apply(node *HttpNode, httpMethod string, httpPath string, all map[string]map[string]*HttpNode)
}

type KeepAliveTCPListener struct {
	*net.TCPListener
	KeepAlivePeriod time.Duration
}

type PanicFunc func(w http.ResponseWriter, r *http.Request, p interface{})

type Param struct {
	Key   string
	Value string
}

type Params []Param

type ProtoMethod struct {
	Adapter     func(context.Context, io.Reader) (interface{}, error)
	PostGate    int8 // 是否开启POST
	PostPath    string
	WbskGate    int8
	WbskPath    string
	Annotations string // the comments leading with "@xxx" prefix
}

type ProtoOpenRuleConfig struct {
	Package  string `json:"package" toml:"package"`     // package
	Service  string `json:"service" toml:"service"`     // service
	Method   string `json:"method" toml:"method"`       // method
	GrpcGate int8   `json:"grpc_gate" toml:"grpc_gate"` // grpc switch
	PostGate int8   `json:"post_gate" toml:"post_gate"` // post switch
	PostPath string `json:"post_path" toml:"post_path"` // post path to instead
	WbskGate int8   `json:"wbsk_gate" toml:"wbsk_gate"` // wbsk switch
	WbskPath string `json:"wbsk_path" toml:"wbsk_path"` // wbsk path to instead
}

type ProtoOpenRuleOption interface {
	Apply(service *ProtoService)
}

type ProtoService struct {
	Desc               *grpc.ServiceDesc       // grpc的service描述符
	Impl               interface{}             // grpc的service实现实例
	Package            string                  // grpc的package名称
	Service            string                  // grpc的service名称
	Methods            map[string]*ProtoMethod // 方法的http适配器
	GrpcGate           int8                    // 是否开始grpc
	ProtoServiceConfig []ProtoOpenRuleOption   // proto service option
}

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

type Server struct {

	// 路由冗余配置及中间结果,在Serve()方法最后会自动清理掉
	*Router // 路由配置信息,
	// contains filtered or unexported fields
}