transport

Documentation

Overview

Package transport provides interfaces for sending and receiving messages.

Index

• type Consumer
• type Inspector
• type Producer

Types

type Consumer

type Consumer interface {
	// Receive returns a message along with the topic from which the message was received.
	Receive() (message.Message, string, error)
}

Consumer is an interface for receiving messages, along with their topics, from a fixed, implementation-defined set of topics. If io.Closer is implemented it will be called when the Consumer is no longer needed.

type Inspector

type Inspector interface {
	// QueueLength returns the queue length of the given topic from the perspective of the given function.
	QueueLength(topic string, function string) (int64, error)
}

Inspector is an interface for inspecting the transport.

type Producer

type Producer interface {
	// Send sends a message to a topic.
	Send(topic string, message message.Message) error

	// Errors returns a channel which receives errors resulting asynchronously from sending messages.
	Errors() <-chan error
}

Producer is an interface for sending messages to arbitrary topics. If io.Closer is implemented it will be called when the Producer is no longer needed.