esppy.connectors.WebSocketPublisher

class esppy.connectors.WebSocketPublisher(url, configUrl, contentType, name=None, is_active=None, sslCertificate=None, sslPassphrase=None, requestHeaders=None, maxevents=None)

Bases: esppy.connectors.base.Connector

Publish websocket events

Parameters

urlstring

Specifies the URL for the WebSocket connection.

configUrlstring

Specifies the URL for the connector configuration file. This configuration file contains information about the transformation steps required to publish events.

contentTypestring

Specifies XML or JSON as the type of content received over the WebSocket connection.

sslCertificatestring, optional

Specifies the location of the SSL certificate to use when connecting to a secure server.

sslPassphrasestring, optional

Specifies the password for the SSL certificate.

requestHeadersstring, optional

Specifies a comma-separated list of request headers to send to the server. The list must consist of name-value pairs in name:value format.

maxeventsint, optional

Specifies the maximum number of events to publish.

Returns

WebSocketPublisher

__init__(self, url, configUrl, contentType, name=None, is_active=None, sslCertificate=None, sslPassphrase=None, requestHeaders=None, maxevents=None)

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

Methods

__init__(self, url, configUrl, contentType)	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