gorabbit

Documentation

Index

• type Client
  • func New(addr string, ops ...Option) *Client
  • func (c *Client) Channel() *amqp.Channel
  • func (c *Client) Close() error
  • func (c *Client) Consume(ctx context.Context, queue string, prefetch int, ...) error
  • func (c *Client) IsLive() bool
  • func (c *Client) IsReady() bool
  • func (c *Client) Iter(ctx context.Context, queue string, prefetch int) func(yield func(delivery amqp.Delivery) bool) error
  • func (c *Client) Publish(ctx context.Context, exchange, key string, pub amqp.Publishing) error
• type Option
  • func WithBackoff(bo backoff.BackOff) Option
  • func WithDialConfig(fns ...func(c *amqp.Config)) Option
  • func WithOnChannelClosed(fn func(error)) Option
  • func WithOnConnectionClosed(fn func(error)) Option

Types

type Client

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

Client is a RabbitMQ client.

func New

func New(addr string, ops ...Option) *Client

New creates a new RabbitMQ client.

func (*Client) Channel

func (c *Client) Channel() *amqp.Channel

Channel returns the current channel. Please note that the channel can be closed and Client will re-open another one and use it, but this one will remain closed.

func (*Client) Close

func (c *Client) Close() error

Close closes the connection and channel.

func (*Client) Consume

func (c *Client) Consume(ctx context.Context, queue string, prefetch int, deliveries chan<- amqp.Delivery) error

Consume consumes messages from a queue into deliveries channel.

func (*Client) IsLive

func (c *Client) IsLive() bool

IsLive returns true if connection and channel are opened.

func (*Client) IsReady

func (c *Client) IsReady() bool

IsReady returns true if connection and channel are opened and ready to use.

func (*Client) Iter

func (c *Client) Iter(ctx context.Context, queue string, prefetch int) func(yield func(delivery amqp.Delivery) bool) error

Iter iterates over messages from a queue.

func (*Client) Publish

func (c *Client) Publish(ctx context.Context, exchange, key string, pub amqp.Publishing) error

Publish publishes a message to an exchange.

type Option

type Option func(c *Client)

Option is a configuration option for the client.

func WithBackoff

func WithBackoff(bo backoff.BackOff) Option

WithBackoff sets the backoff strategy for reconnecting.

func WithDialConfig

func WithDialConfig(fns ...func(c *amqp.Config)) Option

WithDialConfig allows to configure the dial config.

func WithOnChannelClosed

func WithOnChannelClosed(fn func(error)) Option

WithOnChannelClosed sets the function to be called when the channel is closed.

func WithOnConnectionClosed

func WithOnConnectionClosed(fn func(error)) Option

WithOnConnectionClosed sets the function to be called when the connection is closed.