esppy.connectors.SolaceSubscriber

class esppy.connectors.SolaceSubscriber(solhostport=None, soluserid=None, solpassword=None, solvpn=None, soltopic=None, urlhostport=None, name=None, is_active=None, numbufferedmsgs=None, snapshot=None, collapse=None, hotfailover=None, buspersistence=None, rmretdel=None, protofile=None, protomsg=None, configfilesection=None, json=None, dateformat=None, solpasswordencrypted=None)

Bases: esppy.connectors.base.Connector

Subscribe to Solace events

Parameters

solhostportstring

Specifies the appliance to connect to, in the form ‘host:port’

solvpnstring

Specifies the appliance message VPN to assign the client to which the session connects.

soltopicstring

Specifies the Solace destination topic to which to publish

urlhostportstring

Specifies the host:port field in the metadata topic subscribed to on start-up to field metadata requests.

numbufferedmsgsint

Specifies the maximum number of messages buffered by a standby subscriber connector.

snapshotboolean, optional

Specifies whether to send snapshot data

collapsestring, optional

Enables conversion of UPDATE_BLOCK events to make subscriber output publishable. The default value is disabled.

hotfailoverboolean, optional

Enables hot failover mode.

buspersistencestring, optional

Sets the Solace message delivery mode to Guaranteed Messaging. The default value is Direct Messaging.

rmretdelboolean, optional

Specifies to remove all delete events from event blocks received by a subscriber that were introduced by a window retention policy.

protofilestring, optional

Specifies the .proto file that contains the Google Protocol Buffers message definition used to convert event blocks to protobuf messages. When you specify this parameter, you must also specify the protomsg parameter.

protomsgstring, optional

Specifies the name of a Google Protocol Buffers message in the .proto file that you specified with the protofile parameter. Event blocks are converted into this message.

configfilesectionstring, optional

Specifies the name of the section in the connector config file to parse for configuration parameters. Specify the value as [configfilesection].

jsonboolean, optional

Enables transport of event blocks encoded as JSON messages

dateformatstring, optional

Specifies the format of ESP_DATETIME and ESP_TIMESTAMP fields in CSV events. The default behavior is these fields are interpreted as an integer number of seconds (ESP_DATETIME) or microseconds (ESP_TIMESTAMP) since epoch.

solpasswordencryptedboolean, optional

Specifies that solpassword is encrypted

Returns

SolaceSubscriber

__init__(self, solhostport=None, soluserid=None, solpassword=None, solvpn=None, soltopic=None, urlhostport=None, name=None, is_active=None, numbufferedmsgs=None, snapshot=None, collapse=None, hotfailover=None, buspersistence=None, rmretdel=None, protofile=None, protomsg=None, configfilesection=None, json=None, dateformat=None, solpasswordencrypted=None)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self[, solhostport, soluserid, …])	Initialize self.
clear(self)
copy(self[, deep])	Return a copy of the object
from_element(data[, session])	Construct connector from XML definition
from_parameters(conncls[, type, name, …])
from_xml(data[, session])	Construct connector from XML definition
get(self, key[, default])
items(self)
keys(self)
pop(self, key[, default])	If key is not found, d is returned if given, otherwise KeyError is raised.
popitem(self)	as a 2-tuple; but raise KeyError if D is empty.
set_properties(self, \*\*kwargs)	Set connector properties
setdefault(self, key[, default])
to_element(self)	Export connector definition to ElementTree.Element
to_xml(self[, pretty])	Export connector definition to XML
update(\*args, \*\*kwds)	If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v
values(self)

Attributes

connector_key
property_defs