mirror of
https://github.com/foxcpp/maddy.git
synced 2025-04-05 05:57:39 +03:00
a574b9fbb2
There is abstraction 'updates pipe' defined for future use with configuration involving IMAP data replication (e.g. multiple nodes with maddy instances + PostgreSQL replicas + S3 bucket for messages). However, for the case of local SQLite3 DB, limited UDS-based implementation is provided. It solves the problem of maddyctl not being able to tell the server about modifications it makes. Alternative to this approach would be to have server actually perform operations and maddyctl being a dumb API client, but this requires a lot more complex IPC interface and will not work when the server is down.
44 lines
1.4 KiB
Go
44 lines
1.4 KiB
Go
// Package updatepipe implements utilities for serialization and transport of
|
|
// IMAP update objects between processes and machines.
|
|
//
|
|
// Its main goal is provide maddyctl with ability to properly notify the server
|
|
// about changes without relying on it to coordinate access in the first place
|
|
// (so maddyctl can work without a running server or with a broken server
|
|
// instance).
|
|
//
|
|
// Additionally, it can be used to transfer IMAP updates between replicated
|
|
// nodes.
|
|
package updatepipe
|
|
|
|
import (
|
|
"github.com/emersion/go-imap/backend"
|
|
)
|
|
|
|
// The P interface represents the handle for a transport medium used for IMAP
|
|
// updates.
|
|
type P interface {
|
|
// Listen starts the "pull" goroutine that reads updates from the pipe and
|
|
// sends them to the channel.
|
|
//
|
|
// Usually it is not possible to call Listen multiple times for the same
|
|
// pipe.
|
|
//
|
|
// Updates sent using the same UpdatePipe object using Push are not
|
|
// duplicates to the channel passed to Listen.
|
|
Listen(upds chan<- backend.Update) error
|
|
|
|
// InitPush prepares the UpdatePipe to be used as updates source (Push
|
|
// method).
|
|
//
|
|
// It is called implicitly on the first Push call, but calling it
|
|
// explicitly allows to detect initialization errors early.
|
|
InitPush() error
|
|
|
|
// Push writes the update to the pipe.
|
|
//
|
|
// The update will not be duplicated if the UpdatePipe is also listening
|
|
// for updates.
|
|
Push(upd backend.Update) error
|
|
|
|
Close() error
|
|
}
|