Giter Club home page Giter Club logo

basic-pubsub-lib's Introduction

Basic PubSub Library

A lightweight and efficient publish-subscribe system in Go, enhanced with optional file logging features.

Key Features:

  • Easy-to-use API for publishing and subscribing to topics.
  • Built with concurrency in mind to ensure safety across multiple operations.
  • Option to log messages to a file for auditing or debugging purposes.

Usage Guide:

Initialization

Initialize the PubSub system with:

ps := pubsub.NewPubSub[string]()

It is possible to notice that generics are used, you can choose the type of message

Activating File Writer

To log messages to a file, activate the file writer. Note that this will panic if there's an issue opening the file:

ps.ActiveFileWriter("path_to_file.txt")

Deactivating and Closing File Writer

To stop logging and close the file:

ps.CloseFileWriter()

Subscribing to Topics

Register for a specific topic and get a channel to receive its messages:

ch := ps.Subscribe("your_topic")

Subscribing with a Handler

Register a subscriber that uses a handler function to process messages for a specific topic:

unsubscribe := ps.SubscribeWithHandler("your_topic", yourHandlerFunction)

Unsubscribing from Topics

To stop receiving messages from a topic:

ps.Unsubscribe("your_topic", ch)

Publishing Messages

Send a message to all subscribers of a specific topic. If the file writer is active, the message will also be logged to the file. A panic will occur if there's an error writing to the file:

ps.Publish("your_topic", "your_message")

basic-pubsub-lib's People

Contributors

iigabriel avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.