README
¶
Broker
This package abstracts the embedded message queue broker.
Features:
Examples:
package main
import (
"fmt"
"github.com/zourva/pareto/broker"
"time"
)
func main() {
// TODO
}
Documentation
¶
Index ¶
- type EmbeddedNats
- type MQ
- type MQClient
- type MQClientOptions
- type MQTTClient
- type MQTTClientV3
- type MQTTServer
- type Option
- func WithAuthorizationToken(t string) Option
- func WithHost(host string) Option
- func WithLoggerFile(file string) Option
- func WithMonitorHost(host string) Option
- func WithMonitorPort(port int) Option
- func WithPort(port int) Option
- func WithRetryCount(c int) Option
- func WithRetryDuration(d time.Duration) Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type EmbeddedNats ¶
type EmbeddedNats struct {
// contains filtered or unexported fields
}
EmbeddedNats embeds the nats MQ server.
see https://docs.nats.io/running-a-nats-service/clients#embedding-nats and https://dev.to/karanpratapsingh/embedding-nats-in-go-19o.
func NewEmbeddedNats ¶
func NewEmbeddedNats(opts ...Option) (*EmbeddedNats, error)
NewEmbeddedNats creates and initialize an embedded nats server using the given options.
type MQ ¶
type MQ interface {
// Startup starts the broker.
Startup() error
// Shutdown stops the broker.
Shutdown() error
}
MQ is the broker abstraction.
type MQClient ¶
type MQClient interface {
// Connect connects to the given broker using the provided conf.
Connect(*MQClientOptions) error
// Disconnect breaks connection with the broker.
Disconnect()
}
MQClient abstracts the broker client logic.
type MQClientOptions ¶
type MQClientOptions struct {
}
MQClientOptions defines options provided to client when connecting.
type MQTTClient ¶
MQTTClient provides an MQTT v5 compatible client impl.
func NewMQTTClient ¶
func NewMQTTClient(network string, endpoint string) *MQTTClient
NewMQTTClient creates a client and establish a connection to the given broker.
func (*MQTTClient) Connect ¶
func (c *MQTTClient) Connect(connMsg *paho.Connect) error
Connect send CONNECT msg to the broker on the established underlying network connection.
func (*MQTTClient) Disconnect ¶
func (c *MQTTClient) Disconnect() error
Disconnect sends DISCONNECT msg to broker and always close the network connection
type MQTTClientV3 ¶
type MQTTClientV3 struct {
mqtt.Client
// contains filtered or unexported fields
}
MQTTClientV3 provides an MQTT v3/v3.1.1 compatible client impl.
func NewMQTTClientV3 ¶
func NewMQTTClientV3(network string, endpoint string) *MQTTClientV3
NewMQTTClientV3 creates a client and establish a connection to the given broker.
func (*MQTTClientV3) Connect ¶
func (c *MQTTClientV3) Connect(connMsg *paho.Connect) error
Connect connects to broker using v3.1.1 first and then v3 when the first try failed. NOTE: this method use paho.Connect v5 Connect message to keep compatibility.
func (*MQTTClientV3) Disconnect ¶
func (c *MQTTClientV3) Disconnect() error
Disconnect will end the connection with the server, before waiting 3000 ms to wait for cleaning.
type MQTTServer ¶
MQTTServer provides an MQTT v3/v3.1.1 compatible broker impl.
func NewMQTTServer ¶
func NewMQTTServer(name string, endpoint string) *MQTTServer
NewMQTTServer creates a single node MQTT broker with the given name and listen address endpoint.
type Option ¶ added in v0.2.0
type Option = func(*EmbeddedNats)
func WithAuthorizationToken ¶ added in v0.2.0
func WithLoggerFile ¶ added in v0.2.0
WithLoggerFile defines logger for embedded nats, file can be "stdout", "stderr" or any file path. Logging is disabled if file is "", which is the default.
func WithMonitorHost ¶ added in v0.2.0
WithMonitorHost overrides default host "127.0.0.1".
func WithMonitorPort ¶ added in v0.2.0
WithMonitorPort overrides default port 8222.
func WithRetryCount ¶ added in v0.2.0
WithRetryCount overrides default retry count, 3.
func WithRetryDuration ¶ added in v0.2.0
WithRetryDuration overrides default retry duration which is 5 seconds.
Source Files