server

Documentation

Overview

Package server is an interface for a micro server

Index

• Variables
• func NewContext(ctx context.Context, s Server) context.Context
• type Message
• type Option
  • func Address(a string) Option
  • func Advertise(a string) Option
  • func ID(id string) Option
  • func Id(id string) Option
  • func Metadata(md map[string]string) Option
  • func Name(n string) Option
  • func RegisterInterval(t time.Duration) Option
  • func RegisterTTL(t time.Duration) Option
  • func Registry(r registry.Registry) Option
  • func Version(v string) Option
  • func Wait(b bool) Option
• type Options
• type Request
• type Server
  • func FromContext(ctx context.Context) (Server, bool)
  • func NewServer(opt ...Option) Server
• type Stream

Variables

var (
	// DefaultAddress DefaultAddress
	DefaultAddress = ":0"
	// DefaultName DefaultName
	DefaultName = "go-server"
	// DefaultVersion DefaultVersion
	DefaultVersion = "1.0.0"
	// DefaultID DefaultID
	DefaultID = uuid.NewUUID().String()
)

Functions

func NewContext

func NewContext(ctx context.Context, s Server) context.Context

NewContext NewContext

Types

type Message

type Message interface {
	Topic() string
	Payload() interface{}
	ContentType() string
}

Message RPC消息头

type Option

type Option func(*Options)

Option Option

func Address

func Address(a string) Option

Address to bind to - host:port

func Advertise

func Advertise(a string) Option

Advertise The address to advertise for discovery - host:port

func ID

func ID(id string) Option

ID Unique server id

func Id

func Id(id string) Option

Id Unique server id Deprecated: 因为命名规范问题函数将废弃,请用ID代替

func Metadata

func Metadata(md map[string]string) Option

Metadata associated with the server

func Name

func Name(n string) Option

Name Server name

func RegisterInterval

func RegisterInterval(t time.Duration) Option

RegisterInterval specifies the interval on which to re-register

func RegisterTTL

func RegisterTTL(t time.Duration) Option

RegisterTTL Register the service with a TTL

func Registry

func Registry(r registry.Registry) Option

Registry used for discovery

func Version

func Version(v string) Option

Version of the service

func Wait

func Wait(b bool) Option

Wait tells the server to wait for requests to finish before exiting

type Options

type Options struct {
	Registry  registry.Registry
	Metadata  map[string]string
	Name      string
	Address   string
	Advertise string
	ID        string
	Version   string

	RegisterInterval time.Duration
	RegisterTTL      time.Duration

	// Other options for implementations of the interface
	// can be stored in a context
	Context context.Context
}

Options Options

type Request

type Request interface {
	Service() string
	Method() string
	ContentType() string
	Request() interface{}
	// indicates whether the request will be streamed
	Stream() bool
}

Request Request

type Server

type Server interface {
	Options() Options
	OnInit(module module.Module, app module.App, settings *conf.ModuleSettings) error
	Init(...Option) error
	SetListener(listener mqrpc.RPCListener)
	Register(id string, f interface{})
	RegisterGO(id string, f interface{})
	ServiceRegister() error
	ServiceDeregister() error
	Start() error
	Stop() error
	OnDestroy() error
	String() string
	ID() string
	// Deprecated: 因为命名规范问题函数将废弃,请用ID代替
	Id() string
}

Server Server

func FromContext

func FromContext(ctx context.Context) (Server, bool)

FromContext FromContext

func NewServer

func NewServer(opt ...Option) Server

NewServer returns a new server with options passed in

type Stream

type Stream interface {
	Context() context.Context
	Request() Request
	Send(interface{}) error
	Recv(interface{}) error
	Error() error
	Close() error
}

Stream represents a stream established with a client. A stream can be bidirectional which is indicated by the request. The last error will be left in Error(). EOF indicated end of the stream.