component

Documentation

Index

• type Base
  • func (c *Base) AfterInit()
  • func (c *Base) BeforeShutdown()
  • func (c *Base) Init()
  • func (c *Base) Shutdown()
• type Component
• type Handler
• type Option
  • func WithName(name string) Option
  • func WithNameFunc(fn func(string) string) Option
• type Service
  • func NewService(comp Component, opts []Option) *Service
  • func (s *Service) ExtractHandler() error

Types

type Base

type Base struct{}

Base implements a default component for Component.

func (*Base) AfterInit

func (c *Base) AfterInit()

AfterInit was called after the component is initialized.

func (*Base) BeforeShutdown

func (c *Base) BeforeShutdown()

BeforeShutdown was called before the component to shutdown.

func (*Base) Init

func (c *Base) Init()

Init was called to initialize the component.

func (*Base) Shutdown

func (c *Base) Shutdown()

Shutdown was called to shutdown the component.

type Component

type Component interface {
	Init()
	AfterInit()
	BeforeShutdown()
	Shutdown()
}

Component is the interface that represent a component.

type Handler

type Handler struct {
	Receiver reflect.Value  // receiver of method
	Method   reflect.Method // method stub
	Type     reflect.Type   // low-level type of method
	IsRawArg bool           // whether the data need to serialize
}

Handler represents a message.Message's handler's meta information. Handler represents a message.Message's handler's meta information.

type Option

type Option func(options *options)

Option used to customize handler

func WithName

func WithName(name string) Option

WithName used to rename component name

func WithNameFunc

func WithNameFunc(fn func(string) string) Option

WithNameFunc override handler name by specific function such as: strings.ToUpper/strings.ToLower

type Service

type Service struct {
	Name     string              // name of service
	Type     reflect.Type        // type of the receiver
	Receiver reflect.Value       // receiver of methods for the service
	Handlers map[string]*Handler // registered methods
	Options  options             // options
}

Service implements a specific service, some of it's methods will be called when the correspond events is occurred.

func NewService

func NewService(comp Component, opts []Option) *Service

func (*Service) ExtractHandler

func (s *Service) ExtractHandler() error

ExtractHandler extract the set of methods from the receiver value which satisfy the following conditions: - exported method of exported type - two arguments, both of exported type - the first argument is *session.Session - the second argument is []byte or a pointer