exported

Documentation

Index

• Constants
• func NewError(code Code, innerErr error) error
• type Code
• type Error
  • func (e *Error) Error() string
• type NewWebSocketConnArgs
• type ReceiveMode
• type RetryOptions

Constants

const (
	// EventConn is used whenever we create a connection or any links (ie: receivers, senders).
	EventConn log.Event = "azsb.Conn"

	// EventAuth is used when we're doing authentication/claims negotiation.
	EventAuth log.Event = "azsb.Auth"

	// EventReceiver represents operations that happen on Receivers.
	EventReceiver log.Event = "azsb.Receiver"

	// EventSender represents operations that happen on Senders.
	EventSender log.Event = "azsb.Sender"

	// EventAdmin is used for operations in the azservicebus/admin.Client
	EventAdmin log.Event = "azsb.Admin"
)

NOTE: these are publicly exported via type-aliasing in azservicebus/log.go

Functions

func NewError

func NewError(code Code, innerErr error) error

NewError creates a new `Error` instance. NOTE: this function is only exported so it can be used by the `internal` package. It is not available for customers.

Types

type Code

type Code string

Code is an error code, usable by consuming code to work with programatically.

const (
	// CodeUnauthorizedAccess means the credentials provided are not valid for use with
	// a particular entity, or have expired.
	CodeUnauthorizedAccess Code = "unauthorized"

	// CodeConnectionLost means our connection was lost and all retry attempts failed.
	// This typically reflects an extended outage or connection disruption and may
	// require manual intervention.
	CodeConnectionLost Code = "connlost"

	// CodeLockLost means that the lock token you have for a message has expired.
	// This message will be available again after the lock period expires, or, potentially
	// go to the dead letter queue if delivery attempts have been exceeded.
	CodeLockLost Code = "locklost"

	// CodeTimeout means the service timed out during an operation.
	// For instance, if you use ServiceBusClient.AcceptNextSessionForQueue() and there aren't
	// any available sessions it will eventually time out and return an *azservicebus.Error
	// with this code.
	CodeTimeout Code = "timeout"
)

type Error

type Error struct {
	// Code is a stable error code which can be used as part of programatic error handling.
	// The codes can expand in the future, but the values (and their meaning) will remain the same.
	Code Code
	// contains filtered or unexported fields
}

Error represents a Service Bus specific error. NOTE: the Code is considered part of the published API but the message that comes back from Error(), as well as the underlying wrapped error, are NOT and are subject to change.

func (*Error) Error

func (e *Error) Error() string

Error is an error message containing the code and a user friendly message, if any.

type NewWebSocketConnArgs

type NewWebSocketConnArgs struct {
	// Host is the the `wss://<host>` to connect to
	Host string
}

NewWebSocketConnArgs are the arguments to the NewWebSocketConn function you pass if you want to enable websockets.

type ReceiveMode

type ReceiveMode int

ReceiveMode represents the lock style to use for a reciever - either `PeekLock` or `ReceiveAndDelete`

const (
	// PeekLock will lock messages as they are received and can be settled
	// using the Receiver's (Complete|Abandon|DeadLetter|Defer)Message
	// functions.
	PeekLock ReceiveMode = 0
	// ReceiveAndDelete will delete messages as they are received.
	ReceiveAndDelete ReceiveMode = 1
)

type RetryOptions

type RetryOptions struct {
	// MaxRetries specifies the maximum number of attempts a failed operation will be retried
	// before producing an error.
	// The default value is three.  A value less than zero means one try and no retries.
	MaxRetries int32

	// RetryDelay specifies the initial amount of delay to use before retrying an operation.
	// The delay increases exponentially with each retry up to the maximum specified by MaxRetryDelay.
	// The default value is four seconds.  A value less than zero means no delay between retries.
	RetryDelay time.Duration

	// MaxRetryDelay specifies the maximum delay allowed before retrying an operation.
	// Typically the value is greater than or equal to the value specified in RetryDelay.
	// The default Value is 120 seconds.  A value less than zero means there is no cap.
	MaxRetryDelay time.Duration
}

RetryOptions represent the options for retries.