Solace PubSub+ Messaging API for Python.
This package contains the Solace PubSub+ Messaging API for Python.
The Solace PubSub+ Messaging API for Python is developed and supported by the Solace Corporation.
The API provides access to Solace PubSub+ Messaging Service, supporting a variety of Message Exchange Patterns.
Install the API using pip:
pip install solace-pubsubplus
Solace PubSub+ Messaging API for Python requires Python 3.6 or greater.
An online reference for the API is available at docs.solace.com.
There are four primary objects in the PubSub+ Messaging API for Python that applications can use, which are as follows:
from solace.messaging.messaging_service import MessagingService
The starting point for all client-broker connections.
MessagingService defines and controls the connection to the Solace PubSub+ Event Broker.
MessagingService object is created by the
from solace.messaging.publisher.message_publisher import MessagePublisher
The abstract base class for a Message Publisher (
MessagePublisher). Applications do not build
MessagePublisher objects directly, rather an application will invoke a builder.
for one of two derived objects:
DirectMessagePublisher: Created by a
DirectMessagePublishersend messages that are not acknowledged and are not stored on the Solace PubSub+ Event Broker. This is the fastest delivery path because messages are never queued and therefore cannot be delivered to offline
MessageReceiverat a later time. Messages published by
DirectMessagePublisherare eligible for discard when network congestion occurs.
PersistentMessagePublisher: Created by a
PersistentMessagePublishersends messages that are guaranteed to be delivered to
MessageReceiver, even if the
MessageReceiverobject is offline. PubSub+ Event Broker stores the messages until they are delivered and consumed by all subscribing receivers.
from solace.messaging.receiver.message_receiver import MessageReceiver
The abstract base class for a Message Receiver (
Message Receiver). Applications do not build
MessageReceiver objects directly, rather an application will invoke a builder for one of two derived objects:
DirectMessageReceiver: Created by a
DirectMessgeReceiverconsumes messages as they are published.
DirectMessageReceiverwill not receive messages published before the receiver is created or while the receiver is offline.
DirectMessageReceiveris not required to acknowledge received messages.
DirectMessageReceivermay receive messages from any publisher (persistent or direct), but only while the
PersistentMessageReceiver: Created by a
PersistentMessageReceiverconsume messages from a queue created on the Solace Pubsub+ Event broker. When the queue is created and subscriptions applied, it will begin storing messages, even if
PersistentMessageReceiveris offline. Messages are stored until delivered to the
PersistentMessageReceiveracknowledges the message.
PersistentMessageReceiveris responsible for acknowledging messages received to remove them from the PubSub+ Event Broker Queue.
from solace.messaging.core.message import Message
The abstract base class for a
Message. Applications do not build a
Message object directly, rather an application will invoke a builder for an
OutboundMessage (for publish) or
InboundMessage (from a
Sample applications are available at the Solace Developer Community
Solace PubSub+ Messaging API for Python cannot be used in applications that use the Python multiprocessing module.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for solace_pubsubplus-1.3.0-py36-none-win_amd64.whl
Hashes for solace_pubsubplus-1.3.0-py36-none-win32.whl
Hashes for solace_pubsubplus-1.3.0-py36-none-manylinux_2_12_x86_64.whl
Hashes for solace_pubsubplus-1.3.0-py36-none-macosx_10_15_x86_64.whl