xgoframe

Documentation

Index

• Constants
• type Config
  • func DefaultConfig() *Config
  • func RawConfig(key string) *Config
  • func StdConfig(name string) *Config
  • func (config *Config) Address() string
  • func (config *Config) Build() *Server
  • func (config *Config) WithHost(host string) *Config
  • func (config *Config) WithLogger(logger *xlog.Logger) *Config
  • func (config *Config) WithPort(port int) *Config
• type EmptyMessage
  • func (*EmptyMessage) ProtoMessage()
  • func (m *EmptyMessage) Reset()
  • func (m *EmptyMessage) String() string
• type GRPCProxyMessage
  • func (m *GRPCProxyMessage) MarshalJSONPB() ([]byte, error)
  • func (*GRPCProxyMessage) ProtoMessage()
  • func (m *GRPCProxyMessage) Reset()
  • func (m *GRPCProxyMessage) String() string
• type Server
  • func (s *Server) GracefulStop(ctx context.Context) error
  • func (s *Server) Healthz() bool
  • func (s *Server) Info() *server.ServiceInfo
  • func (s *Server) Serve() error
  • func (s *Server) Stop() error

Constants

const ModName = "server.goframe"

ModName mod name

Types

type Config

type Config struct {
	Host          string
	Port          int
	Debug         bool
	DisableMetric bool
	DisableTrace  bool
	// ServiceAddress service address in registry info, default to 'Host:Port'
	ServiceAddress string

	SlowQueryThresholdInMilli int64
	// contains filtered or unexported fields
}

Config HTTP config

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig ...

func RawConfig

func RawConfig(key string) *Config

RawConfig ...

func StdConfig

func StdConfig(name string) *Config

StdConfig Jupiter Standard HTTP Server config

func (*Config) Address

func (config *Config) Address() string

Address ...

func (*Config) Build

func (config *Config) Build() *Server

Build create server instance, then initialize it with necessary interceptor

func (*Config) WithHost

func (config *Config) WithHost(host string) *Config

WithHost ...

func (*Config) WithLogger

func (config *Config) WithLogger(logger *xlog.Logger) *Config

WithLogger ...

func (*Config) WithPort

func (config *Config) WithPort(port int) *Config

WithPort ...

type EmptyMessage

type EmptyMessage struct{}

EmptyMessage ...

func (*EmptyMessage) ProtoMessage

func (*EmptyMessage) ProtoMessage()

ProtoMessage ...

func (*EmptyMessage) Reset

func (m *EmptyMessage) Reset()

Reset ...

func (*EmptyMessage) String

func (m *EmptyMessage) String() string

String ...

type GRPCProxyMessage

type GRPCProxyMessage struct {
	Error   int           `protobuf:"varint,1,opt,name=error" json:"error"`
	Message string        `protobuf:"bytes,2,opt,name=msg" json:"msg"`
	Data    proto.Message `protobuf:"bytes,3,opt,name=data" json:"data"`
}

GRPCProxyMessage ...

func (*GRPCProxyMessage) MarshalJSONPB

func (m *GRPCProxyMessage) MarshalJSONPB() ([]byte, error)

MarshalJSONPB ...

func (*GRPCProxyMessage) ProtoMessage

func (*GRPCProxyMessage) ProtoMessage()

ProtoMessage ...

func (*GRPCProxyMessage) Reset

func (m *GRPCProxyMessage) Reset()

Reset ...

func (*GRPCProxyMessage) String

func (m *GRPCProxyMessage) String() string

String ...

type Server

type Server struct {
	*ghttp.Server
	// contains filtered or unexported fields
}

Server is server core struct

func (*Server) GracefulStop

func (s *Server) GracefulStop(ctx context.Context) error

GracefulStop ..

func (*Server) Healthz

func (s *Server) Healthz() bool

Healthz TODO(roamerlv):

func (*Server) Info

func (s *Server) Info() *server.ServiceInfo

Info ..

func (*Server) Serve

func (s *Server) Serve() error

Serve ..

func (*Server) Stop

func (s *Server) Stop() error

Stop ..