Documentation
¶
Overview ¶
Package conn adds to https://github.com/streadway/amqp Connection ability to reconnect and some optional parameters.
Index ¶
- Variables
- type Connection
- func Connect(url string, opts ...ConnectionOption) *Connection
- func Dial(url string, opts ...ConnectionOption) (*Connection, error)
- func DialConfig(url string, config amqp.Config, opts ...ConnectionOption) (*Connection, error)
- func DialTLS(url string, amqps *tls.Config, opts ...ConnectionOption) (*Connection, error)
- func DialWithDialer(dialer Dialer, opts ...ConnectionOption) (*Connection, error)
- func Open(conn io.ReadWriteCloser, config amqp.Config, opts ...ConnectionOption) (*Connection, error)
- type ConnectionOption
- func Attempts(n int) ConnectionOption
- func Name(name string) ConnectionOption
- func SASL(aa ...amqp.Authentication) ConnectionOption
- func Service(serviceName string) ConnectionOption
- func Vhost(vhost string) ConnectionOption
- func WithConfig(config amqp.Config) ConnectionOption
- func WithContext(ctx context.Context) ConnectionOption
- func WithDelay(min, max time.Duration) ConnectionOption
- func WithDelayBuilder(builder TimeoutBuilder) ConnectionOption
- func WithLogger(logger logger.Logger) ConnectionOption
- type Connector
- type Dialer
- type Notifier
- type Signal
- type TimeoutBuilder
- type Timeouter
Constants ¶
This section is empty.
Variables ¶
var ( DeadlineError = errors.New("the deadline was reached") MaxAttemptsError = errors.New("maximum attempts was reached") CanceledError = errors.New("connection was canceled") Disconnected = errors.New("disconnected") Connected = errors.New("connected") )
Common errors
Functions ¶
This section is empty.
Types ¶
type Connection ¶
type Connection struct {
// contains filtered or unexported fields
}
Connection is a wrapper of amqp.Connection with reconnection ability.
func Connect ¶ added in v1.2.0
func Connect(url string, opts ...ConnectionOption) *Connection
Generic connection function.
func Dial ¶
func Dial(url string, opts ...ConnectionOption) (*Connection, error)
Dial wraps amqp.Dial function and adds reconnection ability. Never returns error.
func DialConfig ¶
func DialConfig(url string, config amqp.Config, opts ...ConnectionOption) (*Connection, error)
DialConfig wraps amqp.DialConfig function and adds reconnection ability. Never returns error.
func DialTLS ¶
func DialTLS(url string, amqps *tls.Config, opts ...ConnectionOption) (*Connection, error)
DialTLS wraps amqp.DialTLS function and adds reconnection ability. Never returns error.
func DialWithDialer ¶
func DialWithDialer(dialer Dialer, opts ...ConnectionOption) (*Connection, error)
DialWithDialer wraps any Dialer and adds reconnection ability. Never returns error.
func Open ¶
func Open(conn io.ReadWriteCloser, config amqp.Config, opts ...ConnectionOption) (*Connection, error)
Open wraps amqp.Open function and adds reconnection ability. Never returns error.
func (*Connection) Channel ¶
func (c *Connection) Channel() (*amqp.Channel, error)
Connection gives direct access to amqp.Connection.
func (*Connection) Close ¶
func (c *Connection) Close() error
func (*Connection) Connection ¶
func (c *Connection) Connection() *amqp.Connection
Connection gives direct access to amqp.Connection.
func (*Connection) NotifyClose ¶
func (c *Connection) NotifyClose() <-chan Signal
NotifyClose notifies user that connection was closed. Channel closes after first notification.
func (*Connection) NotifyConnected ¶
func (c *Connection) NotifyConnected(timeout time.Duration) error
NotifyConnected waits until connection is ready to serve.
type ConnectionOption ¶
type ConnectionOption func(*Connection)
ConnectionOption is a type which represents optional Connection's feature.
func Attempts ¶
func Attempts(n int) ConnectionOption
Attempts sets the maximum attempts to connect/reconnect. When amount rises n, connection stops. When n < 0 Connection tries connect infinitely. -1 by default.
func Name ¶ added in v1.2.0
func Name(name string) ConnectionOption
Set custom connection name, that will be displayed in management plugins.
func SASL ¶ added in v1.2.0
func SASL(aa ...amqp.Authentication) ConnectionOption
func Service ¶ added in v1.2.0
func Service(serviceName string) ConnectionOption
Set custom service name, that will be displayed in client information.
func Vhost ¶ added in v1.2.0
func Vhost(vhost string) ConnectionOption
func WithConfig ¶ added in v1.2.0
func WithConfig(config amqp.Config) ConnectionOption
Directly set dial config.
func WithContext ¶
func WithContext(ctx context.Context) ConnectionOption
WithContext allows use power of Context in connection loop. Common use-case: reconnection cancellation.
func WithDelay ¶
func WithDelay(min, max time.Duration) ConnectionOption
Timeout sets delays for connection between attempts.
func WithDelayBuilder ¶
func WithDelayBuilder(builder TimeoutBuilder) ConnectionOption
WithDelayBuilder changes delay mechanism between attempts
func WithLogger ¶
func WithLogger(logger logger.Logger) ConnectionOption
WithLogger sets logger, which notifies about these events:
type Connector ¶
type Connector func() (*Connection, error)
func ConfigConnector ¶
func ConfigConnector(url string, config amqp.Config, opts ...ConnectionOption) Connector
func DefaultConnector ¶
func DefaultConnector(url string, opts ...ConnectionOption) Connector
func NewConnector ¶ added in v1.2.1
func NewConnector(url string, opts ...ConnectionOption) Connector
type Notifier ¶
type Notifier struct {
// contains filtered or unexported fields
}
Notifier notify receivers when something happen. After notification it closes all channels
type TimeoutBuilder ¶
type TimeoutBuilder func() Timeouter
func CommonTimeoutBuilder ¶
func CommonTimeoutBuilder(min, max time.Duration) TimeoutBuilder
Source Files