queue

Documentation

Overview

Package queue chain底层消息队列模块

Index

• Variables
• func DisableLog()
• type Client
• type Message
  • func NewMessage(id int64, topic string, ty int64, data interface{}) (msg *Message)
  • func NewMessageCallback(id int64, topic string, ty int64, data interface{}, ...) (msg *Message)
  • func (msg *Message) Err() error
  • func (msg *Message) GetData() interface{}
  • func (msg *Message) Reply(replyMsg *Message)
  • func (msg *Message) ReplyErr(title string, err error)
  • func (msg *Message) String() string
• type Module
• type Queue
  • func New(name string) Queue

Variables

var (
	ErrIsQueueClosed    = errors.New("ErrIsQueueClosed")
	ErrQueueTimeout     = errors.New("ErrQueueTimeout")
	ErrQueueChannelFull = errors.New("ErrQueueChannelFull")
)

消息队列的错误

Functions

func DisableLog

func DisableLog()

DisableLog disable log

Types

type Client

type Client interface {
	Send(msg *Message, waitReply bool) (err error) //同步发送消息
	SendTimeout(msg *Message, waitReply bool, timeout time.Duration) (err error)
	Wait(msg *Message) (*Message, error)                               //等待消息处理完成
	WaitTimeout(msg *Message, timeout time.Duration) (*Message, error) //等待消息处理完成
	Recv() chan *Message
	Reply(msg *Message)
	Sub(topic string) //订阅消息
	Close()
	CloseQueue() (*types.Reply, error)
	NewMessage(topic string, ty int64, data interface{}) (msg *Message)
	FreeMessage(msg ...*Message) //回收msg， 需要注意回收时上下文不再引用
	GetConfig() *types.ChainConfig
}

Client 消息队列的接口，每个模块都需要一个发送接受client

type Message

type Message struct {
	Topic string
	Ty    int64
	ID    int64
	Data  interface{}
	// contains filtered or unexported fields
}

Message message struct

func NewMessage

func NewMessage(id int64, topic string, ty int64, data interface{}) (msg *Message)

NewMessage new message

func NewMessageCallback

func NewMessageCallback(id int64, topic string, ty int64, data interface{}, callback func(msg *Message)) (msg *Message)

NewMessageCallback reply block

func (*Message) Err

func (msg *Message) Err() error

Err if err return error msg, or return nil

func (*Message) GetData

func (msg *Message) GetData() interface{}

GetData get message data

func (*Message) Reply

func (msg *Message) Reply(replyMsg *Message)

Reply reply message to reply chan

func (*Message) ReplyErr

func (msg *Message) ReplyErr(title string, err error)

ReplyErr reply error

func (*Message) String

func (msg *Message) String() string

String print the message information

type Module

type Module interface {
	SetQueueClient(client Client)
	//wait for ready
	Wait()
	Close()
}

Module be used for module interface

type Queue

type Queue interface {
	Close()
	Start()
	Client() Client
	Name() string
	SetConfig(cfg *types.ChainConfig)
	GetConfig() *types.ChainConfig
}

Queue only one obj in project Queue only generate Client and start、Close operate, if you send massage or receive massage on Queue, please use Client.

func New

func New(name string) Queue

New new queue struct