queue

package

v2.0.2 Latest Latest Go to latest Published: Nov 15, 2022 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/appootb/substratum

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Init()
type Debug
type EmptyIdempotent
- func (p *EmptyIdempotent) AfterProcess(_ queue.Message, _ queue.ProcessStatus)
- func (p *EmptyIdempotent) BeforeProcess(_ queue.Message) bool
type Message
type Queue
- func (m *Queue) Publish(topic string, content []byte, opts ...queue.PublishOption) error
- func (m *Queue) Subscribe(topic string, handler queue.Consumer, opts ...queue.SubscribeOption) error

Constants ¶

View Source

const (
	DebugLog = "_QUEUE_.debug"
	ErrorLog = "_QUEUE_.error"

	LogTopic  = logger.LogTag + "topic"
	LogGroup  = logger.LogTag + "group"
	LogError  = logger.LogTag + "error"
	LogKey    = logger.LogTag + "key"
	LogStatus = logger.LogTag + "status"
)

Variables ¶

This section is empty.

Functions ¶

func Init ¶

func Init()

Types ¶

type Debug ¶

type Debug struct {
	// contains filtered or unexported fields
}

func (*Debug) Ping ¶

func (m *Debug) Ping() error

func (*Debug) Read ¶

func (m *Debug) Read(topic string, ch chan<- queue.MessageWrapper, opts *queue.SubscribeOptions) error

func (*Debug) Type ¶

func (m *Debug) Type() string

func (*Debug) Write ¶

func (m *Debug) Write(topic string, content []byte, opts *queue.PublishOptions) error

type EmptyIdempotent ¶

type EmptyIdempotent struct{}

func (*EmptyIdempotent) AfterProcess ¶

func (p *EmptyIdempotent) AfterProcess(_ queue.Message, _ queue.ProcessStatus)

AfterProcess is invoked after processing.

func (*EmptyIdempotent) BeforeProcess ¶

func (p *EmptyIdempotent) BeforeProcess(_ queue.Message) bool

BeforeProcess is invoked before process message.

type Message ¶

type Message struct {
	// contains filtered or unexported fields
}

func (*Message) Begin ¶

func (m *Message) Begin()

Begin to process the message.

func (*Message) Cancel ¶

func (m *Message) Cancel()

Cancel indicates the message should be ignored.

func (*Message) Content ¶

func (m *Message) Content() []byte

Content returns the message body content.

func (*Message) End ¶

func (m *Message) End()

End indicates a successful process.

func (*Message) Fail ¶

func (m *Message) Fail()

Fail indicates a failed process.

func (*Message) Group ¶

func (m *Message) Group() string

Group name of this message.

func (*Message) IsPing ¶

func (m *Message) IsPing() bool

IsPing returns true for a ping message.

func (*Message) Key ¶

func (m *Message) Key() string

Key returns the unique key ID of this message.

func (*Message) NotBefore ¶

func (m *Message) NotBefore() time.Time

NotBefore indicates the message should not be processed before this timestamp.

func (*Message) Properties ¶

func (m *Message) Properties() map[string]string

Properties returns the properties of this message.

func (*Message) Requeue ¶

func (m *Message) Requeue()

Requeue indicates the message should be retried.

func (*Message) Retry ¶

func (m *Message) Retry() int

Retry times.

func (*Message) Timestamp ¶

func (m *Message) Timestamp() time.Time

Timestamp indicates the creation time of the message.

func (*Message) Topic ¶

func (m *Message) Topic() string

Topic name of this message.

type Queue ¶

type Queue struct{}

func (*Queue) Publish ¶

func (m *Queue) Publish(topic string, content []byte, opts ...queue.PublishOption) error

Publish writes a message body to the specified topic.

func (m *Queue) Subscribe(topic string, handler queue.Consumer, opts ...queue.SubscribeOption) error

Subscribe consumes the messages of the specified topic.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL