solace package
Solace PubSub+ Messaging API for Python
This package contains a full-featured Python API for developing Python applications. The API follows the builder pattern. Everything begins with a MessagingService.builder() which returns a new MessagingServiceClientBuilder object. With a MessagingServiceClientBuilder object, applications can:
configure a
solace.messaging.messaging_service.MessagingServiceobjectcreate a
solace.messaging.messaging_service.MessagingServiceobject
Before the MessagingService is created, global properties can be set by environment variable. The following environment variables are recognized and handled during API initialization:
SOLCLIENT_GLOBAL_PROP_GSS_KRB_LIB: GSS (Kerberos) library name. If not set the default value is OS specific
Linux/MacOS: libgssapi_krb5.so.2
Windows: secur32.dll
SOLCLIENT_GLOBAL_PROP_SSL_LIB: TLS Protocol libary name. If not set the default value is OS specific:
Linux: libssl.so
MacOS: libssl.dylib
Windows: libssl-1_1.dll
SOLCLIENT_GLOBAL_PROP_CRYPTO_LIB: TLS Cryptography library name. If not set the default value is OS specific:
Linux: libcrypto.so
MacOS: libcrypto.dylib
Windows: libcrypto-1_1.dll-
GLOBAL_GSS_KRB_LIB: Alternate name for SOLCLIENT_GLOBAL_PROP_GSS_KRB_LIB
GLOBAL_SSL_LIB: Alternate name for SOLCLIENT_GLOBAL_PROP_SSL_LIB
GLOBAL_CRYPTO_LIB: Alternate name for SOLCLIENT_GLOBAL_PROP_CRYPTO_LIB
- solace.messaging package
- solace.messaging.builder package
- solace.messaging.builder.direct_message_publisher_builder module
- solace.messaging.builder.direct_message_receiver_builder module
- solace.messaging.builder.message_publisher_builder module
- solace.messaging.builder.message_receiver_builder module
- solace.messaging.builder.persistent_message_publisher_builder module
- solace.messaging.builder.persistent_message_receiver_builder module
- solace.messaging.builder.request_reply_message_publisher_builder module
- solace.messaging.builder.request_reply_message_receiver_builder module
- solace.messaging.builder.transactional_message_publisher_builder module
- solace.messaging.builder.transactional_message_receiver_builder module
- solace.messaging.config package
- solace.messaging.config.solace_constants package
- solace.messaging.config.solace_properties package
- solace.messaging.config.solace_properties.authentication_properties module
- solace.messaging.config.solace_properties.client_properties module
- solace.messaging.config.solace_properties.message_properties module
- solace.messaging.config.solace_properties.publisher_properties module
- solace.messaging.config.solace_properties.receiver_properties module
- solace.messaging.config.solace_properties.service_properties module
- solace.messaging.config.solace_properties.transactional_service_properties module
- solace.messaging.config.solace_properties.transport_layer_properties module
- solace.messaging.config.solace_properties.transport_layer_security_properties module
- solace.messaging.config.authentication_strategy module
- solace.messaging.config.direct_receiver_back_pressure_configuration module
- solace.messaging.config.message_acknowledgement_configuration module
- solace.messaging.config.message_auto_acknowledgement_configuration module
- solace.messaging.config.message_replay_configuration module
- solace.messaging.config.missing_resources_creation_configuration module
- solace.messaging.config.property_based_configuration module
- solace.messaging.config.publisher_back_pressure_configuration module
- solace.messaging.config.receiver_activation_passivation_configuration module
- solace.messaging.config.replay_strategy module
- solace.messaging.config.retry_strategy module
- solace.messaging.config.sub_code module
- solace.messaging.config.transport_protocol_configuration module
- solace.messaging.config.transport_security_strategy module
- solace.messaging.config.updatable_configuration module
- solace.messaging.connections package
- solace.messaging.core package
- solace.messaging.errors package
- solace.messaging.errors.pubsubplus_client_error module
AuthenticationErrorAuthorizationErrorBackPressureErrorIllegalArgumentErrorIllegalStateErrorIncompatibleMessageErrorIncompatibleServiceErrorIncompleteMessageDeliveryErrorInvalidConfigurationErrorInvalidDataTypeErrorInvalidServiceURLErrorMessageDestinationDoesNotExistErrorMessageNotAcknowledgedByBrokerErrorMessageRejectedByBrokerErrorMessageReplayErrorMessageTooBigErrorMissingReplierErrorPubSubPlusClientErrorPubSubPlusClientIOErrorPubSubPlusCoreClientErrorPubSubTimeoutErrorPublisherOverflowErrorServiceUnreachableErrorSolaceSDTErrorTransactionErrorTransactionRollbackErrorTransportErrorUnknownTransactionStateError
- solace.messaging.errors.pubsubplus_client_error module
- solace.messaging.publisher package
- solace.messaging.publisher.direct_message_publisher module
- solace.messaging.publisher.message_publisher module
- solace.messaging.publisher.outbound_message module
- solace.messaging.publisher.persistent_message_publisher module
- solace.messaging.publisher.publisher_health_check module
- solace.messaging.publisher.request_reply_message_publisher module
- solace.messaging.publisher.transactional_message_publisher module
- solace.messaging.receiver package
- solace.messaging.receiver.acknowledgement_support module
- solace.messaging.receiver.async_receiver_subscriptions module
- solace.messaging.receiver.direct_message_receiver module
- solace.messaging.receiver.inbound_message module
- solace.messaging.receiver.message_receiver module
- solace.messaging.receiver.persistent_message_receiver module
- solace.messaging.receiver.receiver_cache_requests module
- solace.messaging.receiver.receiver_flow_control module
- solace.messaging.receiver.receiver_subscriptions module
- solace.messaging.receiver.request_reply_message_receiver module
- solace.messaging.receiver.transactional_message_receiver module
- solace.messaging.resources package
- solace.messaging.resources.cached_message_subscription_request module
- solace.messaging.resources.destination module
- solace.messaging.resources.queue module
- solace.messaging.resources.resource_accessibility module
- solace.messaging.resources.resource_durability module
- solace.messaging.resources.share_name module
- solace.messaging.resources.topic module
- solace.messaging.resources.topic_subscription module
- solace.messaging.utils package
- solace.messaging.utils.cache_request_outcome module
- solace.messaging.utils.cache_request_outcome_listener module
- solace.messaging.utils.converter module
- solace.messaging.utils.error_monitoring module
- solace.messaging.utils.interoperability_support module
- solace.messaging.utils.life_cycle_control module
- solace.messaging.utils.manageable module
- solace.messaging.utils.manageable_publisher module
- solace.messaging.utils.manageable_receiver module
- solace.messaging.message module
MessageMessage.get_application_message_id()Message.get_application_message_type()Message.get_class_of_service()Message.get_correlation_id()Message.get_expiration()Message.get_payload_as_bytes()Message.get_payload_as_dictionary()Message.get_payload_as_list()Message.get_payload_as_string()Message.get_priority()Message.get_properties()Message.get_property()Message.get_rest_interoperability_support()Message.get_sequence_number()Message.has_property()
- solace.messaging.messaging_service module
MessagingServiceMessagingService.add_reconnection_attempt_listener()MessagingService.add_reconnection_listener()MessagingService.add_service_interruption_listener()MessagingService.builder()MessagingService.connect()MessagingService.connect_async()MessagingService.create_direct_message_publisher_builder()MessagingService.create_direct_message_receiver_builder()MessagingService.create_persistent_message_publisher_builder()MessagingService.create_persistent_message_receiver_builder()MessagingService.create_transactional_service_builder()MessagingService.disconnect()MessagingService.disconnect_async()MessagingService.get_application_id()MessagingService.info()MessagingService.is_connectedMessagingService.message_builder()MessagingService.metrics()MessagingService.remove_reconnection_attempt_listener()MessagingService.remove_reconnection_listener()MessagingService.remove_service_interruption_listener()MessagingService.request_reply()MessagingService.set_core_messaging_log_level()MessagingService.update_property()
MessagingServiceClientBuilderMessagingServiceClientBuilder.build()MessagingServiceClientBuilder.from_properties()MessagingServiceClientBuilder.with_authentication_strategy()MessagingServiceClientBuilder.with_connection_retry_strategy()MessagingServiceClientBuilder.with_message_compression()MessagingServiceClientBuilder.with_reconnection_retry_strategy()MessagingServiceClientBuilder.with_transport_security_strategy()
ReconnectionAttemptListenerReconnectionListenerRequestReplyMessagingServiceServiceEventServiceInterruptionListenerTransactionalMessagingServiceTransactionalMessagingService.add_reconnection_attempt_listener()TransactionalMessagingService.add_reconnection_listener()TransactionalMessagingService.commit()TransactionalMessagingService.connect()TransactionalMessagingService.create_transactional_message_publisher_builder()TransactionalMessagingService.create_transactional_message_receiver_builder()TransactionalMessagingService.disconnect()TransactionalMessagingService.is_connectedTransactionalMessagingService.remove_reconnection_attempt_listener()TransactionalMessagingService.remove_reconnection_listener()TransactionalMessagingService.rollback()TransactionalMessagingService.transactional_service_info()
TransactionalMessagingServiceBuilder
- solace.messaging.builder package