asbclient

package module

v0.0.0-...-cf0f3a2 Latest Latest Go to latest Published: Mar 22, 2018 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/chilicat/asbclient

README ¶

Azure Service Bus Client for Go

Golang client with methods to read and write data from ServiceBus queues and topics using REST.

See: https://docs.microsoft.com/en-us/rest/api/servicebus/Introduction

Godoc

Documentation ¶

Overview ¶

Package asbclient is a client for Azure Service Bus.

Index ¶

Variables
type Client
- func New(clientType ClientType, namespace string, sharedAccessKeyName string, ...) Client
type ClientType
type Error
- func (e *Error) Error() string
type Message
type MessageReq
type Time
- func (t *Time) MarshalJSON() ([]byte, error)
- func (t *Time) UnmarshalJSON(b []byte) (err error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrSubscriptionRequired = fmt.Errorf("A subscription is required for Service Bus Topic operations")

ErrSubscriptionRequired is raised when a service bus topics operations is performed without a subscription.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client interface {
	DeleteMessage(item *Message) error
	PeekLockMessage(path string, timeout int) (*Message, error)
	Send(path string, item *MessageReq) error
	SetSubscription(subscription string)
	Unlock(item *Message) error
}

Client is a client for Azure Service Bus (queues and topics). You should use a different client instance for every namespace. For more comprehensive documentation on its various methods, see:

https://msdn.microsoft.com/en-us/library/azure/hh780717.aspx

func New ¶

func New(clientType ClientType, namespace string, sharedAccessKeyName string, sharedAccessKeyValue string) Client

New creates a new client from the given parameters. Their meaning can be found in the MSDN docs at:

https://docs.microsoft.com/en-us/rest/api/servicebus/Introduction

type ClientType ¶

type ClientType int

ClientType denotes the type of client (topic/queue) that is required

const (
	//Queue is a client type for Azure Service Bus queues
	Queue ClientType = iota

	//Topic is a client type for Azure Service Bus topics
	Topic ClientType = iota
)

type Error ¶

type Error struct {
	Code   int
	Detail string
}

Error is the xml structure returned for errors

func (*Error) Error ¶

func (e *Error) Error() string

type Message ¶

type Message struct {
	MessageReq
	DeliveryCount          int
	EnqueuedSequenceNumber int
	EnqueuedTimeUtc        Time
	LockToken              string
	LockedUntilUtc         Time
	MessageID              string `json:"MessageId"`
	SequenceNumber         int
	State                  string
	Location               string

	Body []byte `json:"-"`
}

type MessageReq ¶

type MessageReq struct {
	ContentType   string `json:",omitempty"`
	CorrelationId string `json:",omitempty"`
	SessionID     string `json:"SessionId,omitempty"`
	Label         string `json:",omitempty"`
	ReplyTo       string `json:",omitempty"`
	// TODO: Time span...
	// TimeToLive string `json:",omitempty"`
	To                      string `json:",omitempty"`
	ScheduledEnqueueTimeUtc Time   `json:",omitempty"`
	ReplyToSessionId        string `json:",omitempty"`
	PartitionKey            string `json:",omitempty"`

	Body []byte `json:"-"`
}

Message is an Azure Service Bus message

type Time ¶

type Time struct {
	time.Time
}

Time is a wrapper round time.Time to json encode/decode in RFC1123 fomat

func (*Time) MarshalJSON ¶

func (t *Time) MarshalJSON() ([]byte, error)

MarshalJSON to RFC1123

func (*Time) UnmarshalJSON ¶

func (t *Time) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON from RFC1123

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
example

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL