mfx

Documentation

Index

• Variables
• type LocalResult
  • func CreateLocalModule(l *zap.Logger, s SettingsParams) (LocalResult, error)
• type MQImplementations
• type MessageQueueParams
• type MessageQueueResult
  • func CreateMessageQueueModule(deploy utility.Deployments, mqs MQImplementations) (MessageQueueResult, error)
• type NatsResult
  • func CreateNatsModule(l *zap.Logger, s SettingsParams) (NatsResult, error)
• type SettingsParams
• type SettingsResult
  • func CreateSettingsModule() (SettingsResult, error)

Variables

var LocalModule = fx.Provide(
	func(l *zap.Logger, s SettingsParams) (LocalResult, error) {
		return CreateLocalModule(l, s)
	},
)

LocalModule is a module that provides the local message queue.

var MqModule = fx.Provide(
	func(ap mfx.AppParams, mqs MQImplementations) (out MessageQueueResult, err error) {
		deployment := utility.ParseDeployments(ap.Deployment)
		return CreateMessageQueueModule(deployment, mqs)
	},
)

MqModule is a module that provides the message queue.

var NatsModule = fx.Provide(
	func(l *zap.Logger, s SettingsParams) (NatsResult, error) {
		return CreateNatsModule(l, s)
	},
)

NatsModule is the module for nats message queue

var SettingModule = fx.Provide(
	func() (out SettingsResult, err error) {
		return CreateSettingsModule()
	},
)

SettingModule is a module that provides the settings.

Types

type LocalResult

type LocalResult struct {
	fx.Out
	Local miface.MessageQueue `name:"LocalMQ"`
}

func CreateLocalModule

func CreateLocalModule(l *zap.Logger, s SettingsParams) (LocalResult, error)

CreateLocalModule creates a new local message queue module.

type MQImplementations

type MQImplementations struct {
	fx.In

	NatsMQ  miface.MessageQueue `name:"NatsMQ" optional:"true"`
	KafkaMQ miface.MessageQueue `name:"KafkaMQ" optional:"true"`
	NsqMQ   miface.MessageQueue `name:"NsqMQ" optional:"true"`
	LocalMQ miface.MessageQueue `name:"LocalMQ" optional:"true"`
}

type MessageQueueParams

type MessageQueueParams struct {
	fx.In

	MessageQueue miface.MessageQueue `name:"MessageQueue"`
}

type MessageQueueResult

type MessageQueueResult struct {
	fx.Out

	MessageQueue miface.MessageQueue `name:"MessageQueue"`
}

func CreateMessageQueueModule

func CreateMessageQueueModule(deploy utility.Deployments, mqs MQImplementations) (MessageQueueResult, error)

CreateMessageQueueModule creates a new message queue module.

type NatsResult

type NatsResult struct {
	fx.Out
	NatsMQ miface.MessageQueue `name:"NatsMQ"`
}

func CreateNatsModule

func CreateNatsModule(l *zap.Logger, s SettingsParams) (NatsResult, error)

CreateNatsModule creates a new nats message queue module.

type SettingsParams

type SettingsParams struct {
	fx.In

	// Local channel buffer size
	// https://github.com/ThreeDotsLabs/watermill/blob/master/pubsub/gochannel/pubsub.go#L15
	ChannelBufferSize              int64 `name:"ChannelBufferSize"`
	Persistent                     bool  `name:"Persistent"`
	BlockPublishUntilSubscriberAck bool  `name:"BlockPublishUntilSubscriberAck"`

	// NatsUrl is the URL of the NATS server.
	NatsUrl string `name:"NatsUrl"`
}

type SettingsResult

type SettingsResult struct {
	fx.Out

	// Local Channel buffer size
	// https://github.com/ThreeDotsLabs/watermill/blob/master/pubsub/gochannel/pubsub.go#L15
	ChannelBufferSize              int64 `name:"ChannelBufferSize" envconfig:"CHANNEL_BUFFER_SIZE" default:"1024"`
	Persistent                     bool  `name:"Persistent" envconfig:"PERSISTENT" default:"false"`
	BlockPublishUntilSubscriberAck bool  `name:"BlockPublishUntilSubscriberAck" envconfig:"BLOCK_PUBLISH_UNTIL_SUBSCRIBER_ACK" default:"false"`

	// NatsUrl is the URL of the NATS server.
	NatsUrl string `name:"NatsUrl" envconfig:"NATS_URL" default:"nats://localhost:4222"`
}

func CreateSettingsModule

func CreateSettingsModule() (SettingsResult, error)

CreateSettingsModule creates a new settings module.