mirror of
https://github.com/go-micro/go-micro.git
synced 2024-12-18 08:26:38 +02:00
123 lines
3.2 KiB
Go
123 lines
3.2 KiB
Go
// Package micro is a pluggable framework for microservices
|
|
package micro
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/micro/go-micro/v2/client"
|
|
"github.com/micro/go-micro/v2/server"
|
|
)
|
|
|
|
type serviceKey struct{}
|
|
|
|
// Service is an interface that wraps the lower level libraries
|
|
// within go-micro. Its a convenience method for building
|
|
// and initialising services.
|
|
type Service interface {
|
|
// The service name
|
|
Name() string
|
|
// Init initialises options
|
|
Init(...Option)
|
|
// Options returns the current options
|
|
Options() Options
|
|
// Client is used to call services
|
|
Client() client.Client
|
|
// Server is for handling requests and events
|
|
Server() server.Server
|
|
// Run the service
|
|
Run() error
|
|
// The service implementation
|
|
String() string
|
|
}
|
|
|
|
// Function is a one time executing Service
|
|
type Function interface {
|
|
// Inherits Service interface
|
|
Service
|
|
// Done signals to complete execution
|
|
Done() error
|
|
// Handle registers an RPC handler
|
|
Handle(v interface{}) error
|
|
// Subscribe registers a subscriber
|
|
Subscribe(topic string, v interface{}) error
|
|
}
|
|
|
|
/*
|
|
// Type Event is a future type for acting on asynchronous events
|
|
type Event interface {
|
|
// Publish publishes a message to the event topic
|
|
Publish(ctx context.Context, msg interface{}, opts ...client.PublishOption) error
|
|
// Subscribe to the event
|
|
Subscribe(ctx context.Context, v in
|
|
}
|
|
|
|
// Resource is a future type for defining dependencies
|
|
type Resource interface {
|
|
// Name of the resource
|
|
Name() string
|
|
// Type of resource
|
|
Type() string
|
|
// Method of creation
|
|
Create() error
|
|
}
|
|
*/
|
|
|
|
// Event is used to publish messages to a topic
|
|
type Event interface {
|
|
// Publish publishes a message to the event topic
|
|
Publish(ctx context.Context, msg interface{}, opts ...client.PublishOption) error
|
|
}
|
|
|
|
// Type alias to satisfy the deprecation
|
|
type Publisher = Event
|
|
|
|
type Option func(*Options)
|
|
|
|
var (
|
|
HeaderPrefix = "Micro-"
|
|
)
|
|
|
|
// NewService creates and returns a new Service based on the packages within.
|
|
func NewService(opts ...Option) Service {
|
|
return newService(opts...)
|
|
}
|
|
|
|
// FromContext retrieves a Service from the Context.
|
|
func FromContext(ctx context.Context) (Service, bool) {
|
|
s, ok := ctx.Value(serviceKey{}).(Service)
|
|
return s, ok
|
|
}
|
|
|
|
// NewContext returns a new Context with the Service embedded within it.
|
|
func NewContext(ctx context.Context, s Service) context.Context {
|
|
return context.WithValue(ctx, serviceKey{}, s)
|
|
}
|
|
|
|
// NewFunction returns a new Function for a one time executing Service
|
|
func NewFunction(opts ...Option) Function {
|
|
return newFunction(opts...)
|
|
}
|
|
|
|
// NewEvent creates a new event publisher
|
|
func NewEvent(topic string, c client.Client) Event {
|
|
if c == nil {
|
|
c = client.NewClient()
|
|
}
|
|
return &event{c, topic}
|
|
}
|
|
|
|
// Deprecated: NewPublisher returns a new Publisher
|
|
func NewPublisher(topic string, c client.Client) Event {
|
|
return NewEvent(topic, c)
|
|
}
|
|
|
|
// RegisterHandler is syntactic sugar for registering a handler
|
|
func RegisterHandler(s server.Server, h interface{}, opts ...server.HandlerOption) error {
|
|
return s.Handle(s.NewHandler(h, opts...))
|
|
}
|
|
|
|
// RegisterSubscriber is syntactic sugar for registering a subscriber
|
|
func RegisterSubscriber(topic string, s server.Server, h interface{}, opts ...server.SubscriberOption) error {
|
|
return s.Subscribe(s.NewSubscriber(topic, h, opts...))
|
|
}
|