msgsync

package

v0.1.0 Latest Latest Go to latest Published: Mar 10, 2024 License: Apache-2.0 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

Package msgsync propagates protobuf messages to a particular topic.

This section is empty.

This section is empty.

This section is empty.

type Config struct {
	Topic string
}

Config groups configurations fields. It can be extended with other fields (such as sync/async, partition...).

type Deps struct {
	infra.PluginDeps
	Messaging messaging.Mux
}

Deps groups dependencies injected into the plugin so that they are logically separated from other plugin fields.

type Option func(*Plugin)

Option is a function that can be used in NewPlugin to customize Plugin.

func UseConf(conf Config) Option

UseConf returns Option which injects a particular configuration.

func UseDeps(cb func(*Deps)) Option

UseDeps returns Option that can inject custom dependencies.

func UseMessaging(m messaging.Mux) Option

UseMessaging returns Option that sets Messaging.

type Plugin struct {
	Deps

	Config
	// contains filtered or unexported fields
}

Plugin implements KeyProtoValWriter that propagates protobuf messages to a particular topic (unless the messaging.Mux is not disabled).

func NewPlugin(opts ...Option) *Plugin

NewPlugin creates a new Plugin with the provided Options.

func (p *Plugin) AfterInit() error

AfterInit uses provided MUX connection to build new publisher.

func (p *Plugin) Close() error

Close resources.

func (p *Plugin) Init() error

Init does nothing.

func (p *Plugin) Put(key string, data proto.Message, opts ...datasync.PutOption) error

Put propagates this call to a particular messaging Publisher.

This method is supposed to be called in PubPlugin.AfterInit() or later (even from different go routine).