Request: more documentation (having trouble grokking)  #34

Activity

1. rafalp commented on Mar 10, 2021

   

   rafalp

   on Mar 10, 2021

   Contributor

   More actions

   Hello!

   None of questions you've asked apply to the Broadcaster itself ;)

   Broadcaster is small library that provides unified API over the top of few technologies that support publish-subscribe model. This library only does three things:

   • creates instance of pub-sub server via Broadcast(connection_string)
   • enables applications to push messages to the server with broadcast.publish(...)
   • enables applications to subscribe to the server to receive messages with broadcast.subscribe()

   Everything else has to be implemented by the developer and is outside of this library's scope. If you take example's code and remove lines of code non-specific to the broadcaster, you will get this:

   # Creates pub-sub service using Redis
   broadcast = Broadcast("redis://localhost:6379")
   
   # Sends "message" to the "chatroom" channel
   await broadcast.publish(channel="chatroom", message=message)
   
   # Receives messages sent to the "chatroom" channel and does something with them
     async with broadcast.subscribe(channel="chatroom") as subscriber:
         async for message in subscriber:
             do_something_with_message(message)

   I'm sorry I'm unable to provide the example for FastAPI at this time, but hopefully this will make it little more clear what this library is and what it's not. :)
2. rafalp

   added

   documentationImprovements or additions to documentationImprovements or additions to documentation

   on Mar 10, 2021
3. lefnire commented on Mar 10, 2021

   

   lefnire

   on Mar 10, 2021

   Author

   More actions

   Right, right - definitely not directly related, so it's mostly an out-of-scope question. And thanks for the quick response! Maybe I'll just follow-up here in case someone else has the same question, as the FastAPI Websockets docs points here, and it's not clear how to fit broadcaster's pub/sub into a WebsocketEndpoint class with on_receive.

   I'll take a stab at using this on a project, then post a sample implementation here if I get it working.
4. lovelydinosaur

   closed this as completedon Mar 10, 2021
5. encode

   locked and limited conversation to collaborators on Mar 10, 2021