Skip to content

Latest commit

 

History

History
75 lines (66 loc) · 2.85 KB

README.md

File metadata and controls

75 lines (66 loc) · 2.85 KB
Raw

MESSAGING Client

This is a flexible and extensible messaging client designed to provide a unified interface for producing and consuming messages across various messaging platforms. It allows developers to seamlessly integrate messaging functionality into their applications without being tied to a specific messaging service.

Features

  • General producer interface for sending messages to different messaging platforms.
  • General consumer interface for receiving and processing messages from different messaging platforms.
  • Supports QualityOfService features such as
    • CircuitBreaker
    • Retry
  • Easy-to-use message abstraction for consistent handling of messages across platforms.
  • Can be extended to multiple messaging platforms with easily pluggable interfaces, including:
    • AMQP (Advanced Message Queuing Protocol)
    • Apache Kafka
    • AWS SNS (Simple Notification Service)
    • AWS SQS (Simple Queue Service)
    • GCM (Google Cloud Messaging)
    • GCP Pub/Sub (Google Cloud Pub/Sub)

Installation

To install the messaging client, use the following command:

go get oss.nandlabs.io/golly/clients/messaging

Usage

  1. Import the library into your Go project: 
    import "oss.nandlabs.io/golly/clients/messaging"
  2. Initialize the messaging provider for a specific platform. For example, to use the AMQP extension: 
    type AMQPProvider struct {} // implements the Provider interface defined under the library
amqpProvider := &AMQPProvider{}

manager := messaging.Get()
manager.Register(amqpProvider)
  3. Send a message 
    message := &messaging.Message{
  Body: []byte("Hello, World!"), 
  /// Add any additional properties or metadata
}
destination := url.Parse("amqp://guest:password@localhost:5672/myvhost")
err := manager.Send(destination, message)
if err != nil {
  // Handle error
}
  4. Receive a message 
    // Define the onReceive function
onReceive := func(msg Message) error {
    // Process the message
    // ...

 return nil
}
// Start receiving messages from the channel
manager.Receive(receiverUrl, onReceive)
  5. Repeat steps 2-4 for other messaging platforms by initializing the respective clients.

Extending the library

To add support for additional messaging platforms, you can create new extensions by implementing the producer, consumer, and message interfaces defined in the library. These interfaces provide a consistent way to interact with different messaging systems.

You can refer to the existing extensions, such as amqp, kafka, etc., as examples for creating your own extensions. Ensure that your extension adheres to the interface definitions and follows the library's conventions for consistency.