esppy.connectors.TervelaSubscriber

class esppy.connectors.TervelaSubscriber(tvaprimarytmx=None, tvauserid=None, tvapassword=None, tvatopic=None, tvaclientname=None, tvamaxoutstand=None, numbufferedmsgs=None, urlhostport=None, name=None, is_active=None, snapshot=None, collapse=None, hotfailover=None, tvasecondarytmx=None, tvalogfile=None, tvapubbwlimit=None, tvapubrate=None, tvapubmsgexp=None, rmretdel=None, configfilesection=None, protofile=None, protomsg=None, json=None, dateformat=None, tvapasswordencrypted=None)

Bases: esppy.connectors.base.Connector

Subscribe to Tervela Data Fabric events

Parameters

tvaprimarytmxstring

Specifies the host name or IP address of the primary TMX

tvauseridstring

Specifies a user name defined in the Tervela TPM. Publish-topic entitlement rights must be associated with this user name.

tvapasswordstring

Specifies the password associated with tvauserid

tvatopicstring

Specifies the topic name for the topic to which to subscribed. This topic must be configured on the TPM for the GD service and tvauserid must be assigned the Guaranteed Delivery subscribe rights for this Topic in the TPM.

tvaclientnamestring

Specifies the client name associated with the Tervela Guaranteed Delivery context.

tvamaxoutstandint

Specifies the maximum number of unacknowledged messages that can be published to the Tervela fabric (effectively the size of the publication cache). Should be twice the expected transmit rate.

numbufferedmsgsint

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

urlhostportstring

Specifies the “host/port” string sent in the metadata message published by the connector on topic SAS.META.tvaclientname when it starts.

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

tvasecondarytmxstring, optional

Specifies the host name or IP address of the secondary TMX. Required if logging in to a fault-tolerant pair.

tvalogfilestring, optional

Causes the connector to log to the specified file instead of to syslog (on Linux or Solaris) or Tervela.log (on Windows)

tvapubbwlimitint, optional

Specifies the maximum bandwidth, in Mbps, of data published to the fabric. The default value is 100 Mbps.

tvapubrateint, optional

Specifies the rate at which data messages are published to the fabric, in Kbps. The default value is 30,000 messages per second.

tvapubmsgexpint, optional

Specifies the maximum amount of time, in seconds, that published messages are kept in the cache in the Tervela API.

rmretdelboolean, optional

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

configfilesectionstring, optional

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

protofilestring, optional

Specifies the .proto file that contains the Google Protocol Buffers message definition. This definition is 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.

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.

tvapasswordencryptedboolean, optional

Specifies that tvapassword is encrypted

Returns

TervelaSubscriber

__init__(self, tvaprimarytmx=None, tvauserid=None, tvapassword=None, tvatopic=None, tvaclientname=None, tvamaxoutstand=None, numbufferedmsgs=None, urlhostport=None, name=None, is_active=None, snapshot=None, collapse=None, hotfailover=None, tvasecondarytmx=None, tvalogfile=None, tvapubbwlimit=None, tvapubrate=None, tvapubmsgexp=None, rmretdel=None, configfilesection=None, protofile=None, protomsg=None, json=None, dateformat=None, tvapasswordencrypted=None)

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

Methods

__init__(self[, tvaprimarytmx, tvauserid, …])	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