msghub

package

v3.1.0-beta2 Latest Latest Go to latest Published: Feb 5, 2024 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/inbucket/inbucket

Documentation ¶

Index ¶

type Hub
- func New(historyLen int, extHost *extension.Host) *Hub
type Listener

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Hub ¶

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

Hub relays messages on to its listeners

func New ¶

func New(historyLen int, extHost *extension.Host) *Hub

New constructs a new Hub which will cache historyLen messages in memory for playback to future listeners. A goroutine is created to handle incoming messages; it will run until the provided context is canceled.

func (*Hub) AddListener ¶

func (hub *Hub) AddListener(l Listener)

AddListener registers a listener to receive broadcasted messages.

func (*Hub) Delete ¶

func (hub *Hub) Delete(mailbox string, id string)

Delete removes the message from the history buffer and instructs listeners to do the same.

func (*Hub) Dispatch ¶

func (hub *Hub) Dispatch(msg event.MessageMetadata)

Dispatch queues a message for broadcast by the hub. The message will be placed into the history buffer and then relayed to all registered listeners.

func (*Hub) RemoveListener ¶

func (hub *Hub) RemoveListener(l Listener)

RemoveListener deletes a listener registration, it will cease to receive messages.

func (*Hub) Start ¶

func (hub *Hub) Start(ctx context.Context)

Start Hub processing loop.

func (*Hub) Sync ¶

func (hub *Hub) Sync()

Sync blocks until the msghub has processed its queue up to this point, useful for unit tests.

type Listener ¶

type Listener interface {
	Receive(msg event.MessageMetadata) error
	Delete(mailbox string, id string) error
}

Listener receives the contents of the history buffer, followed by new messages

Source Files ¶

View all Source files

hub.go

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