Categorygithub.com/go-stomp/stomp/v3
modulepackage
3.1.3
Repository: https://github.com/go-stomp/stomp.git
Documentation: pkg.go.dev
Overview
Versions
3
Dependencies
12
Dependents
56
Files
1.7k SLOC

# README

stomp

Go language implementation of a STOMP client library.

Build Status Go Reference

Features:

  • Supports STOMP Specifications Versions 1.0, 1.1, 1.2 (https://stomp.github.io/)
  • Protocol negotiation to select the latest mutually supported protocol
  • Heart beating for testing the underlying network connection
  • Tested against RabbitMQ v3.0.1

Usage Instructions

go get github.com/go-stomp/stomp/v3

For API documentation, see https://pkg.go.dev/github.com/go-stomp/stomp/v3

Breaking changes between this previous version and the current version are documented in breaking_changes.md.

License

Copyright 2012 - Present The go-stomp authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

# Packages

No description provided by the author
Package frame provides functionality for manipulating STOMP frames.
Package server contains a simple STOMP server implementation.
A simple, stand-alone STOMP server.
Package testutil contains operations useful for testing.

# Functions

Connect creates a STOMP connection and performs the STOMP connect protocol sequence.
No description provided by the author
Dial creates a network connection to a STOMP server and performs the STOMP connect protocol sequence.
No description provided by the author
No description provided by the author

# Constants

No acknowledgement is required, the server assumes that the client received the message.
Client acknowledges messages.
Client acknowledges message.
Default receipt timeout in Conn.Disconnect function.
Default time span to add to read/write heart-beat timeouts to avoid premature disconnections due to network latency.
Default send timeout in Conn.Send function.
Default receipt timeout in Conn.Send function.
Default receipt timeout in Subscription.Unsubscribe function.
Reply-To header used for temporary queues/RPC with rabbit.
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

Options for connecting to the STOMP server.
Error values.
Error values.
Error values.
Error values.
Error values.
Error values.
Error values.
Error values.
Error values.
Error values.
Error values.
Error values.
Error values.
Error values.
Error values.
SendOpt contains options for for the Conn.Send and Transaction.Send functions.
SubscribeOpt contains options for for the Conn.Subscribe function.

# Structs

A Conn is a connection to a STOMP server.
ConnectionStats contains the statistics of a connection.
StompError implements the Error interface, and provides additional information about a STOMP error.
A Message represents a message received from the STOMP server.
The Subscription type represents a client subscription to a destination.
A Transaction applies to the sending of messages to the STOMP server, and the acknowledgement of messages received from the STOMP server.

# Interfaces

No description provided by the author
Validator is an interface for validating STOMP frames.

# Type aliases

The AckMode type is an enumeration of the acknowledgement modes for a STOMP subscription.
Version is the STOMP protocol version.