gmq

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

type AmqpConnectionOptions struct {
	// Connection URI. Use `amqp|amqps://username:password@host:port/vhost` format.
	//
	// Default is `amqp://localhost/%2f`.
	URI string
	// Connection timeout in milliseconds.
	//
	// Default or zero value is `3000`.
	ConnectTimeoutMS uint64
	// Time in milliseconds from disconnection to reconnection.
	//
	// Default or zero value is `1000`.
	ReconnectMS uint64
}

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

type AmqpQueueOptions struct {
	// The queue name that is used to map a AMQP queue (unicast) or an exchange (broadcast).
	//
	// The pattern is `^[a-z0-9_-]+([\\.]{1}[a-z0-9_-]+)*$`.
	Name string
	// `true` for the receiver and `false` for the sender.
	IsRecv bool
	// Reliable by selecting the confirm channel (for publish).
	Reliable bool
	// `true` for broadcast and `false` for unicast.
	Broadcast bool
	// Time in milliseconds from disconnection to reconnection.
	//
	// Default or zero value is `1000`.
	ReconnectMS uint64
	// The QoS of the receiver queue.
	//
	// `Note`: this value MUST be a positive value.
	Prefetch uint16
	// Use persistent delivery mode.
	Persistent bool
}

type ConnectionHandler interface {
	// Triggered by `ConnectionStatus`.
	OnStatus(handlerID string, conn GmqConnection, status Status)

	// Triggered when there are errors.
	OnError(handlerID string, conn GmqConnection, err error)
}

type GmqConnection interface {
	// To get the connection status.
	Status() Status

	// To add a connection event handler. This will return an identifier for applications to manage
	// handlers.
	AddHandler(handler ConnectionHandler) string

	// To remove a handler with an idenfier from `AddHandler`.
	RemoveHandler(id string)

	// To connect to the message broker. The `GmqConnection` will connect to the broker using
	// a go-routine and report status with `Status`.
	Connect() error

	// To close the connection.
	Close() error
}

type GmqError int

type GmqQueue interface {
	// To get the queue name.
	Name() string

	// Is the queue a receiver.
	IsRecv() bool

	// To get the connection status.
	Status() Status

	// To set the queue event handler. Use `nil` to remove the handler.
	SetHandler(handler QueueEventHandler)

	// To set the queue message handler.
	SetMsgHandler(handler QueueMessageHandler) error

	// To connect to the message queue. The `GmqQueue` will connect to the queue using a go-routine
	// report status with `Status`.
	//
	// `Note` You MUST call `SetMsgHandler()` before `connect()`.
	Connect() error

	// To close the connection.
	Close() error

	// To send a message (for senders only).
	SendMsg(payload []byte) error
}

type Message interface {
	// To get the payload.
	Payload() []byte

	// Use this if the message is processed successfully.
	Ack() error

	// To requeue the message and the broker will send the message in the future.
	//
	// `Note`: only AMQP or protocols that support requeuing are effective.
	Nack() error
}

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

type MqttConnectionOptions struct {
	// Connection URI. Use `mqtt|mqtts://username:password@host:port` format.
	//
	// Default is `mqtt://localhost`.
	URI string
	// Connection timeout in milliseconds.
	//
	// Default or zero value is `3000`.
	ConnectTimeoutMS uint64
	// Time in milliseconds from disconnection to reconnection.
	//
	// Default or zero value is `1000`.
	ReconnectMS uint64
	// Client identifier. Empty to generate a random client identifier.
	ClientID string
	// Do not clean session flag.
	//
	// `Note`: this is not stable.
	NotCleanSession bool
}

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

type MqttQueueOptions struct {
	// The queue name that is used to map a MQTT topic.
	//
	// The pattern is `^[a-z0-9_-]+([\\.]{1}[a-z0-9_-]+)*$`.
	Name string
	// `true` for the receiver and `false` for the sender.
	IsRecv bool
	// Reliable by selecting the confirm channel (for publish).
	Reliable bool
	// `true` for broadcast and `false` for unicast.
	//
	// `Note`: the unicast queue relies on `shared queue`. See the `SharedPrefix` option.
	Broadcast bool
	// Time in milliseconds from disconnection to reconnection.
	//
	// Default or zero value is `1000`.
	ReconnectMS uint64
	// Used for `broadcast=false`.
	SharedPrefix string
}

type QueueEventHandler interface {
	// Triggered by `ConnectionStatus`.
	OnStatus(queue GmqQueue, status Status)

	// Triggered when there are errors.
	OnError(queue GmqQueue, err error)
}

type QueueMessageHandler interface {
	// Triggered for new incoming `Message`s.
	OnMessage(queue GmqQueue, message Message)
}

type Status int