Skip to content

Table of Contents

quixstreams

quixstreams.app

CancellationTokenSource Objects

class CancellationTokenSource()

Represents a token source that can signal a cancellation System.Threading.CancellationToken

__init__

def __init__()

Initializes a new instance of the CancellationTokenSource class.

is_cancellation_requested

def is_cancellation_requested()

Checks if a cancellation has been requested.

Returns:

  • bool - True if the cancellation has been requested, False otherwise.

cancel

def cancel() -> 'CancellationToken'

Signals a cancellation to the CancellationToken.

token

@property
def token() -> 'CancellationToken'

Gets the associated CancellationToken.

Returns:

  • CancellationToken - The CancellationToken associated with this CancellationTokenSource.

get_net_pointer

def get_net_pointer() -> ctypes.c_void_p

Gets the interop pointer of the CancellationTokenSource object.

Returns:

  • ctypes.c_void_p - The interop pointer of the CancellationTokenSource object.

App Objects

class App()

Provides utilities to handle default streaming behaviors and automatic resource cleanup on shutdown.

run

@staticmethod
def run(cancellation_token: CancellationToken = None,
        before_shutdown: Callable[[], None] = None)

Runs the application, managing streaming behaviors and automatic resource cleanup on shutdown.

Arguments:

  • cancellation_token - An optional CancellationToken to abort the application run with.
  • before_shutdown - An optional function to call before shutting down the application.

quixstreams.builders

quixstreams.builders.eventdatabuilder

EventDataBuilder Objects

@nativedecorator
class EventDataBuilder(object)

Builder for creating event data packages for StreamEventsProducer.

__init__

def __init__(net_pointer: ctypes.c_void_p)

Initializes a new instance of EventDataBuilder.

Arguments:

  • net_pointer - Pointer to an instance of a .net EventDataBuilder.

add_value

def add_value(event_id: str, value: str) -> 'EventDataBuilder'

Adds new event at the time the builder is created for.

Arguments:

  • event_id - The id of the event to set the value for.
  • value - The string value.

Returns:

The builder.

add_tag

def add_tag(tag_id: str, value: str) -> 'EventDataBuilder'

Sets tag value for the values.

Arguments:

  • tag_id - The id of the tag.
  • value - The value of the tag.

Returns:

The builder.

add_tags

def add_tags(tags: Dict[str, str]) -> 'EventDataBuilder'

Copies the tags from the specified dictionary. Conflicting tags will be overwritten.

Arguments:

  • tags - The tags to add.

Returns:

The builder.

publish

def publish()

Publishes the values to the StreamEventsProducer buffer.

See StreamEventsProducer buffer settings for more information on when the values are sent to the broker.

quixstreams.builders.eventdefinitionbuilder

EventDefinitionBuilder Objects

@nativedecorator
class EventDefinitionBuilder(object)

Builder for creating EventDefinitions within StreamPropertiesProducer.

__init__

def __init__(net_pointer: ctypes.c_void_p)

Initializes a new instance of EventDefinitionBuilder.

Arguments:

  • net_pointer - Pointer to an instance of a .net EventDefinitionBuilder.

set_level

def set_level(level: EventLevel) -> 'EventDefinitionBuilder'

Set severity level of the Event.

Arguments:

  • level - The severity level of the event.

Returns:

The builder.

set_custom_properties

def set_custom_properties(custom_properties: str) -> 'EventDefinitionBuilder'

Set custom properties of the Event.

Arguments:

  • custom_properties - The custom properties of the event.

Returns:

The builder.

add_definition

def add_definition(event_id: str,
                   name: str = None,
                   description: str = None) -> 'EventDefinitionBuilder'

Add new Event definition, to define properties like Name or Level, among others.

Arguments:

  • event_id - Event id. This must match the event id you use to publish event values.
  • name - Human friendly display name of the event.
  • description - Description of the event.

Returns:

Event definition builder to define the event properties.

quixstreams.builders.parameterdefinitionbuilder

ParameterDefinitionBuilder Objects

@nativedecorator
class ParameterDefinitionBuilder(object)

Builder for creating ParameterDefinition for StreamTimeseriesProducer.

__init__

def __init__(net_pointer: ctypes.c_void_p)

Initializes a new instance of ParameterDefinitionBuilder.

Arguments:

  • net_pointer - Pointer to an instance of a .net ParameterDefinitionBuilder.

set_range

def set_range(minimum_value: float,
              maximum_value: float) -> 'ParameterDefinitionBuilder'

Set the minimum and maximum range of the parameter.

Arguments:

  • minimum_value - The minimum value.
  • maximum_value - The maximum value.

Returns:

The builder.

set_unit

def set_unit(unit: str) -> 'ParameterDefinitionBuilder'

Set the unit of the parameter.

Arguments:

  • unit - The unit of the parameter.

Returns:

The builder.

set_format

def set_format(format: str) -> 'ParameterDefinitionBuilder'

Set the format of the parameter.

Arguments:

  • format - The format of the parameter.

Returns:

The builder.

set_custom_properties

def set_custom_properties(
        custom_properties: str) -> 'ParameterDefinitionBuilder'

Set the custom properties of the parameter.

Arguments:

  • custom_properties - The custom properties of the parameter.

Returns:

The builder.

add_definition

def add_definition(parameter_id: str,
                   name: str = None,
                   description: str = None) -> 'ParameterDefinitionBuilder'

Add new parameter definition to the StreamTimeseriesProducer. Configure it with the builder methods.

Arguments:

  • parameter_id - The id of the parameter. Must match the parameter id used to send data.
  • name - The human friendly display name of the parameter.
  • description - The description of the parameter.

Returns:

Parameter definition builder to define the parameter properties

quixstreams.builders.timeseriesdatabuilder

TimeseriesDataBuilder Objects

@nativedecorator
class TimeseriesDataBuilder(object)

Builder for managing TimeseriesDataTimestamp instances on TimeseriesBufferProducer.

__init__

def __init__(net_pointer: ctypes.c_void_p)

Initializes a new instance of TimeseriesDataBuilder.

Arguments:

  • net_pointer - Pointer to an instance of a .net TimeseriesDataBuilder.

add_value

def add_value(
    parameter_id: str, value: Union[str, float, int, bytes,
                                    bytearray]) -> 'TimeseriesDataBuilder'

Adds new parameter value at the time the builder is created for.

Arguments:

  • parameter_id - The id of the parameter to set the value for.
  • value - The value of type string, float, int, bytes, or bytearray.

Returns:

The builder.

add_tag

def add_tag(tag_id: str, value: str) -> 'TimeseriesDataBuilder'

Adds a tag to the values.

Arguments:

  • tag_id - The id of the tag.
  • value - The value of the tag.

Returns:

The builder.

add_tags

def add_tags(tags: Dict[str, str]) -> 'TimeseriesDataBuilder'

Copies the tags from the specified dictionary. Conflicting tags will be overwritten.

Arguments:

  • tags - The tags to add.

Returns:

The builder.

publish

def publish()

Publish the values.

quixstreams.configuration

quixstreams.configuration.saslmechanism

quixstreams.configuration.securityoptions

SecurityOptions Objects

class SecurityOptions(object)

A class representing security options for configuring SSL encryption with SASL authentication in Kafka.

__init__

def __init__(ssl_certificates: str,
             username: str,
             password: str,
             sasl_mechanism: SaslMechanism = SaslMechanism.ScramSha256)

Initializes a new instance of SecurityOptions configured for SSL encryption with SASL authentication.

Arguments:

  • ssl_certificates - The path to the folder or file containing the certificate authority certificate(s) used to validate the SSL connection.
  • Example - "./certificates/ca.cert"
  • username - The username for SASL authentication.
  • password - The password for SASL authentication.
  • sasl_mechanism - The SASL mechanism to use. Defaults to ScramSha256.

get_net_pointer

def get_net_pointer()

Retrieves the .NET pointer for the current SecurityOptions instance.

Returns:

  • ctypes.c_void_p - The .NET pointer.

quixstreams.exceptions.quixapiexception

quixstreams.helpers

quixstreams.helpers.dotnet.datetimeconverter

DateTimeConverter Objects

class DateTimeConverter()

datetime_to_python

@staticmethod
def datetime_to_python(hptr: ctypes.c_void_p) -> datetime.datetime

Converts dotnet pointer to DateTime and frees the pointer.

Arguments:

  • hptr - Handler Pointer to .Net type DateTime

Returns:

datetime.datetime: Python type datetime

datetime_to_dotnet

@staticmethod
def datetime_to_dotnet(value: datetime.datetime) -> ctypes.c_void_p

Arguments:

  • value - Python type datetime

Returns:

ctypes.c_void_p: Handler Pointer to .Net type DateTime

timespan_to_python

@staticmethod
def timespan_to_python(uptr: ctypes.c_void_p) -> datetime.timedelta

Converts dotnet pointer to Timespan as binary and frees the pointer.

Arguments:

  • uptr - Pointer to .Net type TimeSpan

Returns:

datetime.timedelta: Python type timedelta

timedelta_to_dotnet

@staticmethod
def timedelta_to_dotnet(value: datetime.timedelta) -> ctypes.c_void_p

Arguments:

  • value - Python type timedelta

Returns:

ctypes.c_void_p: Pointer to unmanaged memory containing TimeSpan

quixstreams.helpers.enumconverter

quixstreams.helpers.exceptionconverter

quixstreams.helpers.nativedecorator

quixstreams.helpers.timeconverter

TimeConverter Objects

class TimeConverter()

A utility class for converting between different time representations.

offset_from_utc

The local time ahead of utc by this amount of nanoseconds

to_unix_nanoseconds

@staticmethod
def to_unix_nanoseconds(value: datetime) -> int

Converts a datetime object to UNIX timestamp in nanoseconds.

Arguments:

  • value - The datetime object to be converted.

Returns:

  • int - The UNIX timestamp in nanoseconds.

to_nanoseconds

@staticmethod
def to_nanoseconds(value: timedelta) -> int

Converts a timedelta object to nanoseconds.

Arguments:

  • value - The timedelta object to be converted.

Returns:

  • int - The duration in nanoseconds.

from_nanoseconds

@staticmethod
def from_nanoseconds(value: int) -> timedelta

Converts a duration in nanoseconds to a timedelta object.

Arguments:

  • value - The duration in nanoseconds.

Returns:

  • timedelta - The corresponding timedelta object.

from_unix_nanoseconds

@staticmethod
def from_unix_nanoseconds(value: int) -> datetime

Converts a UNIX timestamp in nanoseconds to a datetime object.

Arguments:

  • value - The UNIX timestamp in nanoseconds.

Returns:

  • datetime - The corresponding datetime object.

from_string

@staticmethod
def from_string(value: str) -> int

Converts a string representation of a timestamp to a UNIX timestamp in nanoseconds.

Arguments:

  • value - The string representation of a timestamp.

Returns:

  • int - The corresponding UNIX timestamp in nanoseconds.

quixstreams.kafkastreamingclient

KafkaStreamingClient Objects

@nativedecorator
class KafkaStreamingClient(object)

A Kafka streaming client capable of creating topic consumer and producers.

__init__

def __init__(broker_address: str,
             security_options: SecurityOptions = None,
             properties: Dict[str, str] = None,
             debug: bool = False)

Initializes a new instance of the KafkaStreamingClient.

Arguments:

  • broker_address - The address of the Kafka cluster.
  • security_options - Optional security options for the Kafka client.
  • properties - Optional extra properties for broker configuration.
  • debug - Whether debugging should be enabled. Defaults to False.

get_topic_consumer

def get_topic_consumer(
    topic: str,
    consumer_group: str = None,
    commit_settings: Union[CommitOptions, CommitMode] = None,
    auto_offset_reset: AutoOffsetReset = AutoOffsetReset.Latest
) -> TopicConsumer

Gets a topic consumer capable of subscribing to receive incoming streams.

Arguments:

  • topic - The name of the topic.
  • consumer_group - The consumer group ID to use for consuming messages. Defaults to None.
  • commit_settings - The settings to use for committing. If not provided, defaults to committing every 5000 messages or 5 seconds, whichever is sooner.
  • auto_offset_reset - The offset to use when there is no saved offset for the consumer group. Defaults to AutoOffsetReset.Latest.

Returns:

  • TopicConsumer - An instance of TopicConsumer for the specified topic.

get_topic_producer

def get_topic_producer(topic: str) -> TopicProducer

Gets a topic producer capable of publishing stream messages.

Arguments:

  • topic - The name of the topic.

Returns:

  • TopicProducer - An instance of TopicProducer for the specified topic.

get_raw_topic_consumer

def get_raw_topic_consumer(
    topic: str,
    consumer_group: str = None,
    auto_offset_reset: Union[AutoOffsetReset,
                             None] = None) -> RawTopicConsumer

Gets a topic consumer capable of subscribing to receive non-quixstreams incoming messages.

Arguments:

  • topic - The name of the topic.
  • consumer_group - The consumer group ID to use for consuming messages. Defaults to None.
  • auto_offset_reset - The offset to use when there is no saved offset for the consumer group. Defaults to None.

Returns:

  • RawTopicConsumer - An instance of RawTopicConsumer for the specified topic.

get_raw_topic_producer

def get_raw_topic_producer(topic: str) -> RawTopicProducer

Gets a topic producer capable of publishing non-quixstreams messages.

Arguments:

  • topic - The name of the topic.

Returns:

  • RawTopicProducer - An instance of RawTopicProducer for the specified topic.

quixstreams.logging

quixstreams.models

quixstreams.models.autooffsetreset

AutoOffsetReset Objects

class AutoOffsetReset(Enum)

Enum representing the policy on how a consumer should behave when consuming from a topic partition when there is no initial offset.

Latest

Latest: Starts from the newest message if there is no stored offset.

Earliest

Earliest: Starts from the oldest message if there is no stored offset.

Error

Error: Throws an exception if there is no stored offset.

quixstreams.models.codecsettings

CodecSettings Objects

class CodecSettings(object)

Global Codec settings for streams.

set_global_codec_type

@staticmethod
def set_global_codec_type(codec_type: CodecType)

Sets the codec type to be used by producers and transfer package value serialization.

quixstreams.models.codectype

CodecType Objects

class CodecType(Enum)

Codecs available for serialization and deserialization of streams.

quixstreams.models.commitmode

quixstreams.models.commitoptions

CommitOptions Objects

@nativedecorator
class CommitOptions(object)

__init__

def __init__(net_pointer: ctypes.c_void_p = None)

Initializes a new instance of CommitOptions

Arguments:

  • net_pointer: Pointer to an instance of a .net CommitOptions.

auto_commit_enabled

@property
def auto_commit_enabled() -> bool

Gets whether automatic committing is enabled. If automatic committing is not enabled, other values are ignored. Default is True.

auto_commit_enabled

@auto_commit_enabled.setter
def auto_commit_enabled(value: bool) -> None

Sets whether automatic committing is enabled. If automatic committing is not enabled, other values are ignored. Default is True.

commit_interval

@property
def commit_interval() -> Optional[int]

Gets the interval of automatic commit in ms. Default is 5000.

commit_interval

@commit_interval.setter
def commit_interval(value: Optional[int]) -> None

Sets the interval of automatic commit in ms. Default is 5000.

commit_every

@property
def commit_every() -> Optional[int]

Gets the number of messages to automatically commit at. Default is 5000.

commit_every

@commit_every.setter
def commit_every(value: Optional[int]) -> None

Sets the number of messages to automatically commit at. Default is 5000.

quixstreams.models.eventdata

EventData Objects

@nativedecorator
class EventData(object)

Represents a single point in time with event value and tags attached to it.

__init__

def __init__(event_id: str = None,
             time: Union[int, str, datetime, pd.Timestamp] = None,
             value: str = None,
             net_pointer: ctypes.c_void_p = None)

Initializes a new instance of EventData.

Arguments:

  • event_id - The unique id of the event the value belongs to.
  • time - The time at which the event has occurred in nanoseconds since epoch or as a datetime.
  • value - The value of the event.
  • net_pointer - Pointer to an instance of a .net EventData.

id

@property
def id() -> str

Gets the globally unique identifier of the event.

id

@id.setter
def id(value: str) -> None

Sets the globally unique identifier of the event.

value

@property
def value() -> str

Gets the value of the event.

value

@value.setter
def value(value: str) -> None

Sets the value of the event.

tags

@property
def tags() -> Dict[str, str]

Gets the tags for the timestamp.

If a key is not found, it returns None. The dictionary key is the tag id. The dictionary value is the tag value.

timestamp_nanoseconds

@property
def timestamp_nanoseconds() -> int

Gets timestamp in nanoseconds.

timestamp_milliseconds

@property
def timestamp_milliseconds() -> int

Gets timestamp in milliseconds.

timestamp

@property
def timestamp() -> datetime

Gets the timestamp in datetime format.

timestamp_as_time_span

@property
def timestamp_as_time_span() -> timedelta

Gets the timestamp in timespan format.

clone

def clone()

Clones the event data.

Returns:

  • EventData - Cloned EventData object.

add_tag

def add_tag(tag_id: str, tag_value: str) -> 'EventData'

Adds a tag to the event.

Arguments:

  • tag_id - The id of the tag.
  • tag_value - The value to set.

Returns:

  • EventData - The updated EventData object.

add_tags

def add_tags(tags: Dict[str, str]) -> 'EventData'

Adds tags from the specified dictionary. Conflicting tags will be overwritten.

Arguments:

  • tags - The tags to add.

Returns:

  • EventData - The updated EventData object.

remove_tag

def remove_tag(tag_id: str) -> 'EventData'

Removes a tag from the event.

Arguments:

  • tag_id - The id of the tag to remove.

Returns:

  • EventData - The updated EventData object.

get_net_pointer

def get_net_pointer()

Gets the associated .net object pointer.

Returns:

The .net object pointer.

quixstreams.models.eventdefinition

EventDefinition Objects

class EventDefinition(object)

Describes additional context for the event

__init__

def __init__(net_pointer: ctypes.c_void_p)

Initializes a new instance of EventDefinition

NOTE: Do not initialize this class manually. Instances of it are available on StreamEventsConsumer.definitions

Arguments:

  • net_pointer: Pointer to an instance of a .net EventDefinition

quixstreams.models.eventlevel

quixstreams.models.netdict

ReadOnlyNetDict Objects

class ReadOnlyNetDict(object)

Experimental. Acts as a proxy between a .net dictionary and a python dict. Useful if .net dictionary is observable and reacts to changes

NetDict Objects

class NetDict(ReadOnlyNetDict)

Experimental. Acts as a proxy between a .net dictionary and a python list.

constructor_for_string_string

@staticmethod
def constructor_for_string_string(net_pointer=None)

Creates an empty dotnet list for strings if no pointer provided, else wraps in NetDict with string converters

quixstreams.models.netlist

NetReadOnlyList Objects

class NetReadOnlyList(object)

Experimental. Acts as a proxy between a .net collection and a python list. Useful if .net collection is observable and reacts to changes

NetList Objects

class NetList(NetReadOnlyList)

Experimental. Acts as a proxy between a .net collection and a python list. Useful if .net collection is observable and reacts to changes

constructor_for_string

@staticmethod
def constructor_for_string(net_pointer=None)

Creates an empty dotnet list for strings if no pointer provided, else wraps in NetDict with string converters

quixstreams.models.parameterdefinition

ParameterDefinition Objects

class ParameterDefinition(object)

Describes additional context for the parameter

__init__

def __init__(net_pointer: ctypes.c_void_p)

Initializes a new instance of ParameterDefinition

NOTE: Do not initialize this class manually. Instances of it are available on StreamTimeseriesConsumer.definitions

Arguments:

  • net_pointer: Pointer to an instance of a .net ParameterDefinition.

quixstreams.models.parametervalue

ParameterValue Objects

@nativedecorator
class ParameterValue(object)

Represents a single parameter value of either numeric, string, or binary type.

__init__

def __init__(net_pointer: ctypes.c_void_p)

Initializes a new instance of ParameterValue.

Arguments:

  • net_pointer - The .net object pointer representing ParameterValue.

numeric_value

@property
def numeric_value() -> float

Gets the numeric value of the parameter if the underlying parameter is of numeric type.

numeric_value

@numeric_value.setter
def numeric_value(value: float)

Sets the numeric value of the parameter and updates the type to numeric.

Arguments:

  • value - The numeric value to set.

string_value

@property
def string_value() -> str

Gets the string value of the parameter if the underlying parameter is of string type.

string_value

@string_value.setter
def string_value(value: str)

Sets the string value of the parameter and updates the type to string.

Arguments:

  • value - The string value to set.

binary_value

@property
def binary_value() -> bytes

Gets the binary value of the parameter if the underlying parameter is of binary type.

binary_value

@binary_value.setter
def binary_value(value: Union[bytearray, bytes])

Sets the binary value of the parameter and updates the type to binary.

Arguments:

  • value - The binary value to set.

type

@property
def type() -> ParameterValueType

Gets the type of value, which is numeric, string, binary if set, otherwise empty

value

@property
def value()

Gets the underlying value.

get_net_pointer

def get_net_pointer() -> ctypes.c_void_p

Gets the associated .net object pointer.

quixstreams.models.streamconsumer

quixstreams.models.streamconsumer.streameventsconsumer

StreamEventsConsumer Objects

@nativedecorator
class StreamEventsConsumer(object)

Consumer for streams, which raises EventData and EventDefinitions related messages

__init__

def __init__(stream_consumer, net_pointer: ctypes.c_void_p)

Initializes a new instance of StreamEventsConsumer. NOTE: Do not initialize this class manually, use StreamConsumer.events to access an instance of it

Arguments:

  • stream_consumer - The Stream consumer which owns this stream event consumer
  • net_pointer - Pointer to an instance of a .net StreamEventsConsumer

on_data_received

@property
def on_data_received() -> Callable[['StreamConsumer', EventData], None]

Gets the handler for when an events data package is received for the stream.

Returns:

Callable[['StreamConsumer', EventData], None]: The first parameter is the stream the event is received for. The second is the event.

on_data_received

@on_data_received.setter
def on_data_received(
        value: Callable[['StreamConsumer', EventData], None]) -> None

Sets the handler for when an events data package is received for the stream.

Arguments:

  • value - The first parameter is the stream the event is received for. The second is the event.

on_definitions_changed

@property
def on_definitions_changed() -> Callable[['StreamConsumer'], None]

Gets the handler for event definitions have changed for the stream.

Returns:

Callable[['StreamConsumer'], None]: The first parameter is the stream the event definitions changed for.

on_definitions_changed

@on_definitions_changed.setter
def on_definitions_changed(value: Callable[['StreamConsumer'], None]) -> None

Sets the handler for event definitions have changed for the stream.

Arguments:

  • value - The first parameter is the stream the event definitions changed for.

definitions

@property
def definitions() -> List[EventDefinition]

Gets the latest set of event definitions.

quixstreams.models.streamconsumer.streampropertiesconsumer

StreamPropertiesConsumer Objects

@nativedecorator
class StreamPropertiesConsumer(object)

Represents properties and metadata of the stream. All changes to these properties are automatically populated to this class.

__init__

def __init__(stream_consumer: 'StreamConsumer', net_pointer: ctypes.c_void_p)

Initializes a new instance of StreamPropertiesConsumer. NOTE: Do not initialize this class manually, use StreamConsumer.properties to access an instance of it.

Arguments:

  • stream_consumer - The Stream consumer that owns this stream event consumer.
  • net_pointer - Pointer to an instance of a .NET StreamPropertiesConsumer.

on_changed

@property
def on_changed() -> Callable[['StreamConsumer'], None]

Gets the handler for when the stream properties change.

Returns:

Callable[[StreamConsumer], None]: The event handler for stream property changes. The first parameter is the StreamConsumer instance for which the change is invoked.

on_changed

@on_changed.setter
def on_changed(value: Callable[['StreamConsumer'], None]) -> None

Sets the handler for when the stream properties change.

Arguments:

  • value - The first parameter is the stream it is invoked for.

name

@property
def name() -> str

Gets the name of the stream.

location

@property
def location() -> str

Gets the location of the stream.

time_of_recording

@property
def time_of_recording() -> datetime

Gets the datetime of the recording.

metadata

@property
def metadata() -> Dict[str, str]

Gets the metadata of the stream.

parents

@property
def parents() -> List[str]

Gets the list of Stream IDs for the parent streams.

get_net_pointer

def get_net_pointer() -> ctypes.c_void_p

Gets the .NET pointer for the StreamPropertiesConsumer instance.

Returns:

  • ctypes.c_void_p - .NET pointer for the StreamPropertiesConsumer instance.

quixstreams.models.streamconsumer.streamtimeseriesconsumer

StreamTimeseriesConsumer Objects

@nativedecorator
class StreamTimeseriesConsumer(object)

Consumer for streams, which raises TimeseriesData and ParameterDefinitions related messages

__init__

def __init__(stream_consumer, net_pointer: ctypes.c_void_p)

Initializes a new instance of StreamTimeseriesConsumer. NOTE: Do not initialize this class manually. Use StreamConsumer.timeseries to access an instance of it.

Arguments:

  • stream_consumer - The Stream consumer which owns this stream event consumer.
  • net_pointer .net object - Pointer to an instance of a .net StreamTimeseriesConsumer.

on_data_received

@property
def on_data_received() -> Callable[['StreamConsumer', TimeseriesData], None]

Gets the handler for when data is received (without buffering).

Returns:

Callable[['StreamConsumer', TimeseriesData], None]: The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in TimeseriesData format.

on_data_received

@on_data_received.setter
def on_data_received(
        value: Callable[['StreamConsumer', TimeseriesData], None]) -> None

Sets the handler for when data is received (without buffering).

Arguments:

  • value - The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in TimeseriesData format.

on_raw_received

@property
def on_raw_received() -> Callable[['StreamConsumer', TimeseriesDataRaw], None]

Gets the handler for when data is received (without buffering) in raw transport format.

Returns:

Callable[['StreamConsumer', TimeseriesDataRaw], None]: The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in TimeseriesDataRaw format.

on_raw_received

@on_raw_received.setter
def on_raw_received(
        value: Callable[['StreamConsumer', TimeseriesDataRaw], None]) -> None

Sets the handler for when data is received (without buffering) in raw transport format.

Arguments:

  • value - The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in TimeseriesDataRaw format.

on_dataframe_received

@property
def on_dataframe_received(
) -> Callable[['StreamConsumer', pandas.DataFrame], None]

Gets the handler for when data is received (without buffering) in pandas DataFrame format.

Returns:

Callable[['StreamConsumer', pandas.DataFrame], None]: The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in pandas DataFrame format.

on_dataframe_received

@on_dataframe_received.setter
def on_dataframe_received(
        value: Callable[['StreamConsumer', pandas.DataFrame], None]) -> None

Sets the handler for when data is received (without buffering) in pandas DataFrame format.

Arguments:

  • value - The function that handles the data received. The first parameter is the stream that receives the data, and the second is the data in pandas DataFrame format.

on_definitions_changed

@property
def on_definitions_changed() -> Callable[['StreamConsumer'], None]

Gets the handler for when the parameter definitions have changed for the stream.

Returns:

Callable[['StreamConsumer'], None]: The function that handles the parameter definitions change. The first parameter is the stream for which the parameter definitions changed.

on_definitions_changed

@on_definitions_changed.setter
def on_definitions_changed(value: Callable[['StreamConsumer'], None]) -> None

Sets the handler for when the parameter definitions have changed for the stream.

Arguments:

  • value - The function that handles the parameter definitions change. The first parameter is the stream for which the parameter definitions changed.

definitions

@property
def definitions() -> List[ParameterDefinition]

Gets the latest set of parameter definitions.

create_buffer

def create_buffer(
    *parameter_filter: str,
    buffer_configuration: TimeseriesBufferConfiguration = None
) -> TimeseriesBufferConsumer

Creates a new buffer for consuming data according to the provided parameter_filter and buffer_configuration.

Arguments:

  • parameter_filter - Zero or more parameter identifiers to filter as a whitelist. If provided, only those parameters will be available through this buffer.
  • buffer_configuration - An optional TimeseriesBufferConfiguration.

Returns:

  • TimeseriesBufferConsumer - An consumer that will raise new data consumed via the on_data_released event.

get_net_pointer

def get_net_pointer() -> ctypes.c_void_p

Gets the .NET pointer for the StreamTimeseriesConsumer instance.

Returns:

  • ctypes.c_void_p - .NET pointer for the StreamTimeseriesConsumer instance.

quixstreams.models.streamconsumer.timeseriesbufferconsumer

TimeseriesBufferConsumer Objects

class TimeseriesBufferConsumer(TimeseriesBuffer)

Represents a class for consuming data from a stream in a buffered manner.

__init__

def __init__(stream_consumer, net_pointer: ctypes.c_void_p = None)

Initializes a new instance of TimeseriesBufferConsumer.

NOTE: Do not initialize this class manually, use StreamTimeseriesConsumer.create_buffer to create it.

Arguments:

  • stream_consumer - The Stream consumer which owns this timeseries buffer consumer.
  • net_pointer - Pointer to an instance of a .net TimeseriesBufferConsumer. Defaults to None.

Raises:

  • Exception - If net_pointer is None.

get_net_pointer

def get_net_pointer() -> ctypes.c_void_p

Retrieves the pointer to the .net TimeseriesBufferConsumer instance.

Returns:

  • ctypes.c_void_p - The pointer to the .net TimeseriesBufferConsumer instance.

quixstreams.models.streamendtype

quixstreams.models.streampackage

StreamPackage Objects

@nativedecorator
class StreamPackage(object)

Default model implementation for non-typed message packages of the Telemetry layer. It holds a value and its type.

__init__

def __init__(net_pointer: ctypes.c_void_p)

Initializes a new instance of StreamPackage.

Notes:

Do not initialize this class manually. Will be initialized by StreamConsumer.on_package_received.

Arguments:

  • net_pointer - Pointer to an instance of a .net StreamPackage.

transport_context

@property
def transport_context() -> Dict[str, str]

Context holder for package when transporting through the pipeline.

to_json

def to_json() -> str

Serialize the package into JSON.

Returns:

  • str - The serialized JSON string of the package.

get_net_pointer

def get_net_pointer() -> ctypes.c_void_p

Gets the associated .net object pointer.

Returns:

  • ctypes.c_void_p - The .net object pointer.

quixstreams.models.streamproducer

quixstreams.models.streamproducer.streameventsproducer

StreamEventsProducer Objects

@nativedecorator
class StreamEventsProducer(object)

Helper class for producing EventDefinitions and EventData.

__init__

def __init__(net_pointer: ctypes.c_void_p)

Initializes a new instance of StreamEventsProducer.

Arguments:

  • net_pointer - Pointer to an instance of a .NET StreamEventsProducer.

flush

def flush()

Immediately publishes the event definitions from the buffer without waiting for buffer condition to fulfill (200ms timeout). TODO: Verify 200ms timeout value.

default_tags

@property
def default_tags() -> Dict[str, str]

Gets default tags injected to all event values sent by the producer.

default_location

@property
def default_location() -> str

Gets the default Location of the events. Event definitions added with add_definition will be inserted at this location. See add_location for adding definitions at a different location without changing default. Example: "/Group1/SubGroup2"

default_location

@default_location.setter
def default_location(value: str)

Sets the default Location of the events. Event definitions added with add_definition will be inserted at this location. See add_location for adding definitions at a different location without changing default.

Arguments:

  • value - Location string, e.g., "/Group1/SubGroup2".

epoch

@property
def epoch() -> datetime

The unix epoch from, which all other timestamps in this model are measured from in nanoseconds.

epoch

@epoch.setter
def epoch(value: datetime)

Sets the default epoch used for event values.

publish

def publish(data: Union[EventData, pd.DataFrame], **columns) -> None

Publish an event into the stream.

Arguments:

  • data - EventData object or a pandas dataframe.
  • columns - Column names if the dataframe has different columns from 'id', 'timestamp', and 'value'. For instance, if 'id' is in the column 'event_id', id='event_id' must be passed as an argument.

Raises:

  • TypeError - If the data argument is neither an EventData nor pandas dataframe.

add_timestamp

def add_timestamp(time: Union[datetime, timedelta]) -> EventDataBuilder

Start adding a new set of event values at the given timestamp.

Arguments:

  • time - The time to use for adding new event values.
  • datetime: The datetime to use for adding new event values. NOTE, epoch is not used.
  • timedelta: The time since the default epoch to add the event values at

Returns:

  • EventDataBuilder - Event data builder to add event values at the provided time.

add_timestamp_milliseconds

def add_timestamp_milliseconds(milliseconds: int) -> EventDataBuilder

Start adding a new set of event values at the given timestamp.

Arguments:

  • milliseconds - The time in milliseconds since the default epoch to add the event values at.

Returns:

  • EventDataBuilder - Event data builder to add event values at the provided time.

add_timestamp_nanoseconds

def add_timestamp_nanoseconds(nanoseconds: int) -> EventDataBuilder

Start adding a new set of event values at the given timestamp.

Arguments:

  • nanoseconds - The time in nanoseconds since the default epoch to add the event values at.

Returns:

  • EventDataBuilder - Event data builder to add event values at the provided time.

add_definition

def add_definition(event_id: str,
                   name: str = None,
                   description: str = None) -> EventDefinitionBuilder

Add new Event definition to define properties like Name or Level, among others.

Arguments:

  • event_id - The id of the event. Must match the event id used to send data.
  • name - The human-friendly display name of the event.
  • description - The description of the event.

Returns:

  • EventDefinitionBuilder - EventDefinitionBuilder to define properties of the event or add additional events.

add_location

def add_location(location: str) -> EventDefinitionBuilder

Add a new location in the events groups hierarchy.

Arguments:

  • location - The group location.

Returns:

  • EventDefinitionBuilder - EventDefinitionBuilder to define the events under the specified location.

quixstreams.models.streamproducer.streampropertiesproducer

StreamPropertiesProducer Objects

@nativedecorator
class StreamPropertiesProducer(object)

Represents properties and metadata of the stream. All changes to these properties are automatically published to the underlying stream.

__init__

def __init__(net_pointer: ctypes.c_void_p)

Initializes a new instance of StreamPropertiesProducer.

Arguments:

  • net_pointer - Pointer to an instance of a .net StreamPropertiesProducer.

name

@property
def name() -> str

Gets the human friendly name of the stream.

Returns:

  • str - The human friendly name of the stream.

name

@name.setter
def name(value: str)

Sets the human friendly name of the stream.

Arguments:

  • value - The new human friendly name of the stream.

location

@property
def location() -> str

Gets the location of the stream in the data catalogue.

Returns:

  • str - The location of the stream in the data catalogue, e.g., "/cars/ai/carA/".

location

@location.setter
def location(value: str)

Sets the location of the stream in the data catalogue.

Arguments:

  • value - The new location of the stream in the data catalogue.

metadata

@property
def metadata() -> Dict[str, str]

" Gets the metadata of the stream.

Returns:

Dict[str, str]: The metadata of the stream.

parents

@property
def parents() -> List[str]

Gets the list of stream ids of the parent streams.

Returns:

  • List[str] - The list of stream ids of the parent streams.

time_of_recording

@property
def time_of_recording() -> datetime

Gets the datetime of the stream recording.

Returns:

  • datetime - The datetime of the stream recording.

time_of_recording

@time_of_recording.setter
def time_of_recording(value: datetime)

Sets the time of the stream recording.

Arguments:

  • value - The new time of the stream recording.

flush_interval

@property
def flush_interval() -> int

Gets the automatic flush interval of the properties metadata into the channel (in milliseconds).

Returns:

  • int - The automatic flush interval in milliseconds, default is 30000.

flush_interval

@flush_interval.setter
def flush_interval(value: int)

Sets the automatic flush interval of the properties metadata into the channel (in milliseconds).

Arguments:

  • value - The new flush interval in milliseconds.

flush

def flush()

Immediately publishes the properties yet to be sent instead of waiting for the flush timer (20ms).

quixstreams.models.streamproducer.streamtimeseriesproducer

StreamTimeseriesProducer Objects

@nativedecorator
class StreamTimeseriesProducer(object)

Helper class for producing ParameterDefinition and TimeseriesData.

__init__

def __init__(stream_producer, net_pointer: ctypes.c_void_p)

Initializes a new instance of StreamTimeseriesProducer.

Arguments:

  • stream_producer - The Stream producer which owns this stream timeseries producer.
  • net_pointer - Pointer to an instance of a .net StreamTimeseriesProducer.

flush

def flush()

Immediately publish timeseries data and definitions from the buffer without waiting for buffer condition to fulfill for either.

add_definition

def add_definition(parameter_id: str,
                   name: str = None,
                   description: str = None) -> ParameterDefinitionBuilder

Add new parameter definition to the StreamTimeseriesProducer. Configure it with the builder methods.

Arguments:

  • parameter_id - The id of the parameter. Must match the parameter id used to send data.
  • name - The human friendly display name of the parameter.
  • description - The description of the parameter.

Returns:

  • ParameterDefinitionBuilder - Builder to define the parameter properties.

add_location

def add_location(location: str) -> ParameterDefinitionBuilder

Add a new location in the parameters groups hierarchy.

Arguments:

  • location - The group location.

Returns:

  • ParameterDefinitionBuilder - Builder to define the parameters under the specified location.

default_location

@property
def default_location() -> str

Gets the default location of the parameters. Parameter definitions added with add_definition will be inserted at this location. See add_location for adding definitions at a different location without changing default.

Returns:

  • str - The default location of the parameters, e.g., "/Group1/SubGroup2".

default_location

@default_location.setter
def default_location(value: str)

Sets the default location of the parameters. Parameter definitions added with add_definition will be inserted at this location. See add_location for adding definitions at a different location without changing default.

Arguments:

  • value - The new default location of the parameters, e.g., "/Group1/SubGroup2".

buffer

@property
def buffer() -> TimeseriesBufferProducer

Get the buffer for producing timeseries data.

Returns:

  • TimeseriesBufferProducer - The buffer for producing timeseries data.

publish

def publish(
        packet: Union[TimeseriesData, pd.DataFrame,
                      TimeseriesDataRaw]) -> None

Publish the given packet to the stream without any buffering.

Arguments:

  • packet - The packet containing TimeseriesData, TimeseriesDataRaw, or pandas DataFrame.

Notes:

  • Pandas DataFrame should contain 'time' label, else the first integer label will be taken as time.
  • Tags should be prefixed by TAG__ or they will be treated as parameters.

Examples:

Send a pandas DataFrame: pdf = pandas.DataFrame({'time': [1, 5], - 'panda_param' - [123.2, 5]}) instance.publish(pdf)

Send a pandas DataFrame with multiple values: pdf = pandas.DataFrame({'time': [1, 5, 10], - 'panda_param' - [123.2, None, 12], - 'panda_param2' - ["val1", "val2", None]}) instance.publish(pdf)

Send a pandas DataFrame with tags: pdf = pandas.DataFrame({'time': [1, 5, 10], - 'panda_param' - [123.2, 5, 12], - 'TAG__Tag1' - ["v1", 2, None], - 'TAG__Tag2' - [1, None, 3]}) instance.publish(pdf)

Raises:

  • Exception - If the given type is not supported for publishing.

quixstreams.models.streamproducer.timeseriesbufferproducer

TimeseriesBufferProducer Objects

@nativedecorator
class TimeseriesBufferProducer(TimeseriesBuffer)

A class for producing timeseries data to a StreamProducer in a buffered manner.

__init__

def __init__(stream_producer, net_pointer: ctypes.c_void_p)

Initializes a new instance of TimeseriesBufferProducer. NOTE: Do not initialize this class manually, use StreamTimeseriesProducer.buffer to access an instance of it

Arguments:

  • stream_producer - The Stream producer which owns this timeseries buffer producer
  • net_pointer - Pointer to an instance of a .net TimeseriesBufferProducer

Raises:

  • Exception - If TimeseriesBufferProducer is None

default_tags

@property
def default_tags() -> Dict[str, str]

Get default tags injected for all parameters values sent by this buffer.

Returns:

Dict[str, str]: A dictionary containing the default tags

epoch

@property
def epoch() -> datetime

Get the default epoch used for parameter values.

Returns:

  • datetime - The default epoch used for parameter values

epoch

@epoch.setter
def epoch(value: datetime)

Set the default epoch used for parameter values. Datetime added on top of all the Timestamps.

Arguments:

  • value - The default epoch to set for parameter values

add_timestamp

def add_timestamp(time: Union[datetime, timedelta]) -> TimeseriesDataBuilder

Start adding a new set of parameter values at the given timestamp.

Arguments:

  • time - The time to use for adding new parameter values.
  • datetime: The datetime to use for adding new parameter values. NOTE, epoch is not used
  • timedelta: The time since the default epoch to add the parameter values at

Returns:

  • TimeseriesDataBuilder - A TimeseriesDataBuilder instance for adding parameter values

Raises:

  • ValueError - If 'time' is None or not an instance of datetime or timedelta

add_timestamp_nanoseconds

def add_timestamp_nanoseconds(nanoseconds: int) -> TimeseriesDataBuilder

Start adding a new set of parameter values at the given timestamp.

Arguments:

  • nanoseconds - The time in nanoseconds since the default epoch to add the parameter values at

Returns:

  • TimeseriesDataBuilder - A TimeseriesDataBuilder instance for adding parameter values

flush

def flush()

Immediately publishes the data from the buffer without waiting for the buffer condition to be fulfilled.

publish

def publish(packet: Union[TimeseriesData, pd.DataFrame]) -> None

Publish the provided timeseries packet to the buffer.

Arguments:

  • packet - The packet containing TimeseriesData or panda DataFrame
  • packet type panda.DataFrame:
  • Note 1: panda data frame should contain 'time' label, else the first integer label will be taken as time.
  • Note 2: Tags should be prefixed by TAG__ or they will be treated as timeseries parameters

Examples:

Send a panda data frame: pdf = panda.DataFrame({'time': [1, 5], - 'panda_param' - [123.2, 5]})

instance.publish(pdf)

Send a panda data frame with multiple values: pdf = panda.DataFrame({'time': [1, 5, 10], - 'panda_param' - [123.2, None, 12], - 'panda_param2' - ["val1", "val2", None]})

instance.publish(pdf)

Send a panda data frame with tags: pdf = panda.DataFrame({'time': [1, 5, 10], - 'panda_param' - [123.2, 5, 12],, - 'TAG__Tag1' - ["v1", 2, None], - 'TAG__Tag2' - [1, None, 3]})

instance.publish(pdf)

Raises:

  • Exception - If the packet type is not supported

quixstreams.models.timeseriesbuffer

TimeseriesBuffer Objects

@nativedecorator
class TimeseriesBuffer(object)

Represents a class used to consume and produce stream messages in a buffered manner. When buffer conditions are not configured, it acts a pass-through, raising each message as arrives.

__init__

def __init__(stream, net_pointer: ctypes.c_void_p)

Initializes a new instance of TimeseriesBuffer.

NOTE: Do not initialize this class manually, use StreamProducer.timeseries.buffer to create it.

Arguments:

  • stream - The stream the buffer is created for.
  • net_pointer - Pointer to a .net TimeseriesBuffer object.

on_data_released

@property
def on_data_released() -> Callable[
    [Union['StreamConsumer', 'StreamProducer'], TimeseriesData], None]

Gets the handler for when the stream receives data.

Returns:

Callable[[Union['StreamConsumer', 'StreamProducer'], TimeseriesData], None]: The event handler. The first parameter is the stream the data is received for, second is the data in TimeseriesData format.

on_data_released

@on_data_released.setter
def on_data_released(
    value: Callable[
        [Union['StreamConsumer', 'StreamProducer'], TimeseriesData], None]
) -> None

Sets the handler for when the stream receives data.

Arguments:

  • value - The event handler. The first parameter is the stream the data is received for, second is the data in TimeseriesData format.

on_raw_released

@property
def on_raw_released() -> Callable[
    [Union['StreamConsumer', 'StreamProducer'], TimeseriesDataRaw], None]

Gets the handler for when the stream receives raw data.

Returns:

Callable[[Union['StreamConsumer', 'StreamProducer'], TimeseriesDataRaw], None]: The event handler. The first parameter is the stream the data is received for, second is the data in TimeseriesDataRaw format.

on_raw_released

@on_raw_released.setter
def on_raw_released(
    value: Callable[
        [Union['StreamConsumer', 'StreamProducer'], TimeseriesDataRaw], None]
) -> None

Sets the handler for when the stream receives raw data.

Arguments:

  • value - The event handler. The first parameter is the stream the data is received for, second is the data in TimeseriesDataRaw format.

on_dataframe_released

@property
def on_dataframe_released() -> Callable[
    [Union['StreamConsumer', 'StreamProducer'], pandas.DataFrame], None]

Gets the handler for when the stream receives data as a pandas DataFrame.

Returns:

Callable[[Union['StreamConsumer', 'StreamProducer'], pandas.DataFrame], None]: The event handler. The first parameter is the stream the data is received for, second is the data in pandas.DataFrame format.

on_dataframe_released

@on_dataframe_released.setter
def on_dataframe_released(
    value: Callable[
        [Union['StreamConsumer', 'StreamProducer'], pandas.DataFrame], None]
) -> None

Sets the handler for when the stream receives data as a pandas DataFrame.

Arguments:

  • value - The event handler. The first parameter is the stream the data is received for, second is the data in pandas.DataFrame format.

filter

@property
def filter() -> Callable[[TimeseriesDataTimestamp], bool]

Gets the custom function to filter the incoming data before adding it to the buffer. If returns true, data is added otherwise not. Defaults to none (disabled).

filter

@filter.setter
def filter(value: Callable[[TimeseriesDataTimestamp], bool])

Sets the custom function to filter incoming data before adding to the buffer.

The custom function takes a TimeseriesDataTimestamp object as input and returns a boolean value. If the function returns True, the data is added to the buffer, otherwise not. By default, this feature is disabled (None).

Arguments:

  • value - Custom filter function.

custom_trigger

@property
def custom_trigger() -> Callable[[TimeseriesData], bool]

Gets the custom trigger function, which is invoked after adding a new timestamp to the buffer.

If the custom trigger function returns True, the buffer releases content and triggers relevant callbacks. By default, this feature is disabled (None).

Returns:

Callable[[TimeseriesData], bool]: Custom trigger function.

custom_trigger

@custom_trigger.setter
def custom_trigger(value: Callable[[TimeseriesData], bool])

Sets the custom trigger function, which is invoked after adding a new timestamp to the buffer.

If the custom trigger function returns True, the buffer releases content and triggers relevant callbacks. By default, this feature is disabled (None).

Arguments:

  • value - Custom trigger function.

packet_size

@property
def packet_size() -> Optional[int]

Gets the maximum packet size in terms of values for the buffer.

Each time the buffer has this amount of data, a callback method, such as on_data_released, is invoked, and the data is cleared from the buffer. By default, this feature is disabled (None).

Returns:

  • Optional[int] - Maximum packet size for the buffer.

packet_size

@packet_size.setter
def packet_size(value: Optional[int])

Sets the maximum packet size in terms of values for the buffer.

Each time the buffer has this amount of data, a callback method, such as on_data_released, is invoked, and the data is cleared from the buffer. By default, this feature is disabled (None).

Arguments:

  • value - Maximum packet size for the buffer.

time_span_in_nanoseconds

@property
def time_span_in_nanoseconds() -> Optional[int]

Gets the maximum time between timestamps for the buffer in nanoseconds.

When the difference between the earliest and latest buffered timestamp surpasses this number, a callback method, such as on_data_released, is invoked, and the data is cleared from the buffer. By default, this feature is disabled (None).

Returns:

  • Optional[int] - Maximum time between timestamps in nanoseconds.

time_span_in_nanoseconds

@time_span_in_nanoseconds.setter
def time_span_in_nanoseconds(value: Optional[int])

Sets the maximum time between timestamps for the buffer in nanoseconds.

When the difference between the earliest and latest buffered timestamp surpasses this number, a callback method, such as on_data_released, is invoked, and the data is cleared from the buffer. By default, this feature is disabled (None).

Arguments:

  • value - Maximum time between timestamps in nanoseconds.

time_span_in_milliseconds

@property
def time_span_in_milliseconds() -> Optional[int]

Gets the maximum time between timestamps for the buffer in milliseconds.

This property retrieves the maximum time between the earliest and latest buffered timestamp in milliseconds. If the difference surpasses this number, a callback method, such as on_data_released, is invoked, and the data is cleared from the buffer. Note that this property is a millisecond converter on top of time_span_in_nanoseconds, and both work with the same underlying value. Defaults to None (disabled).

Returns:

  • Optional[int] - The maximum time difference between timestamps in milliseconds, or None if disabled.

time_span_in_milliseconds

@time_span_in_milliseconds.setter
def time_span_in_milliseconds(value: Optional[int])

Sets the maximum time between timestamps for the buffer in milliseconds.

This property sets the maximum time between the earliest and latest buffered timestamp in milliseconds. If the difference surpasses this number, a callback method, such as on_data_released, is invoked, and the data is cleared from the buffer. Note that this property is a millisecond converter on top of time_span_in_nanoseconds, and both work with the same underlying value. Defaults to None (disabled).

Arguments:

  • value - The maximum time difference between timestamps in milliseconds, or None to disable.

buffer_timeout

@property
def buffer_timeout() -> Optional[int]

Gets the maximum duration in milliseconds for which the buffer will be held. When the configured value has elapsed or other buffer conditions are met, a callback method, such as on_data_released, is invoked. Defaults to None (disabled).

Returns:

  • Optional[int] - The maximum duration in milliseconds before invoking a callback method, or None if disabled.

buffer_timeout

@buffer_timeout.setter
def buffer_timeout(value: Optional[int])

Sets the maximum duration in milliseconds for which the buffer will be held. When the configured value has elapsed or other buffer conditions are met, a callback method, such as on_data_released, is invoked. Defaults to None (disabled).

Arguments:

  • value - The maximum duration in milliseconds before invoking a callback method, or None to disable.

get_net_pointer

def get_net_pointer() -> ctypes.c_void_p

Gets the associated .net object pointer.

Returns:

  • ctypes.c_void_p - The .net object pointer.

quixstreams.models.timeseriesbufferconfiguration

TimeseriesBufferConfiguration Objects

@nativedecorator
class TimeseriesBufferConfiguration(object)

Describes the configuration for timeseries buffers When buffer conditions are not configured, it acts a pass-through, raising each message as arrives.

__init__

def __init__(net_pointer: ctypes.c_void_p = None)

Initializes a new instance of TimeseriesBufferConfiguration.

Arguments:

  • net_pointer - Can be ignored, here for internal purposes .net object: The .net object representing a TimeseriesBufferConfiguration. Defaults to None.

packet_size

@property
def packet_size() -> Optional[int]

Gets the maximum packet size in terms of values for the buffer.

When the buffer reaches this number of values, a callback method, such as on_data_released, is invoked and the buffer is cleared. If not set, defaults to None (disabled).

Returns:

  • Optional[int] - The maximum packet size in values or None if disabled.

packet_size

@packet_size.setter
def packet_size(value: Optional[int])

Sets the maximum packet size in terms of values for the buffer.

When the buffer reaches this number of values, a callback method, such as on_data_released, is invoked and the buffer is cleared. If not set, defaults to None (disabled).

Arguments:

  • value - The maximum packet size in values or None to disable.

time_span_in_nanoseconds

@property
def time_span_in_nanoseconds() -> Optional[int]

Gets the maximum time difference between timestamps in the buffer, in nanoseconds.

When the difference between the earliest and latest buffered timestamp exceeds this value, a callback method, such as on_data_released, is invoked and the data is cleared from the buffer. If not set, defaults to None (disabled).

Returns:

  • Optional[int] - The maximum time span in nanoseconds or None if disabled.

time_span_in_nanoseconds

@time_span_in_nanoseconds.setter
def time_span_in_nanoseconds(value: Optional[int])

Sets the maximum time difference between timestamps in the buffer, in nanoseconds.

When the difference between the earliest and latest buffered timestamp exceeds this value, a callback method, such as on_data_released, is invoked and the data is cleared from the buffer. If not set, defaults to None (disabled).

Arguments:

  • value - The maximum time span in nanoseconds or None to disable.

time_span_in_milliseconds

@property
def time_span_in_milliseconds() -> Optional[int]

Gets the maximum time difference between timestamps in the buffer, in milliseconds.

When the difference between the earliest and latest buffered timestamp exceeds this value, a callback method, such as on_data_released, is invoked and the data is cleared from the buffer. If not set, defaults to None (disabled).

Note: This is a millisecond converter on top of time_span_in_nanoseconds. They both work with the same underlying value.

Returns:

  • Optional[int] - The maximum time span in milliseconds or None if disabled.

time_span_in_milliseconds

@time_span_in_milliseconds.setter
def time_span_in_milliseconds(value: Optional[int])

Sets the maximum time difference between timestamps in the buffer, in milliseconds.

When the difference between the earliest and latest buffered timestamp exceeds this value, a callback method, such as on_data_released, is invoked and the data is cleared from the buffer. If not set, defaults to None (disabled).

Arguments:

  • value - The maximum time span in nanoseconds or None to disable.

buffer_timeout

@property
def buffer_timeout() -> Optional[int]

Gets the maximum duration for which the buffer will be held before releasing the events through callbacks, such as on_data_released.

A callback will be invoked once the configured value has elapsed or other buffer conditions are met. If not set, defaults to None (disabled).

Returns:

  • Optional[int] - The maximum buffer timeout in milliseconds or None if disabled.

buffer_timeout

@buffer_timeout.setter
def buffer_timeout(value: Optional[int])

Sets the maximum duration for which the buffer will be held before releasing the events through callbacks, such as on_data_released.

A callback will be invoked once the configured value has elapsed or other buffer conditions are met. If not set, defaults to None (disabled).

Arguments:

  • value - The maximum buffer timeout in milliseconds or None to disable.

custom_trigger_before_enqueue

@property
def custom_trigger_before_enqueue(
) -> Callable[[TimeseriesDataTimestamp], bool]

Gets the custom function that is called before adding a timestamp to the buffer.

If the function returns True, the buffer releases content and triggers relevant callbacks before adding the timestamp to the buffer. If not set, defaults to None (disabled).

Returns:

Callable[[TimeseriesDataTimestamp], bool]: The custom function or None if disabled.

custom_trigger_before_enqueue

@custom_trigger_before_enqueue.setter
def custom_trigger_before_enqueue(value: Callable[[TimeseriesDataTimestamp],
                                                  bool])

Sets the custom function that is called before adding a timestamp to the buffer.

If the function returns True, the buffer releases content and triggers relevant callbacks before adding the timestamp to the buffer. If not set, defaults to None (disabled).

Arguments:

  • value - The custom function or None to disable.

filter

@property
def filter() -> Callable[[TimeseriesDataTimestamp], bool]

Gets the custom function used to filter incoming data before adding it to the buffer.

If the function returns True, the data is added to the buffer; otherwise, it is not. If not set, defaults to None (disabled).

Returns:

Callable[[TimeseriesDataTimestamp], bool]: The custom filter function or None if disabled.

filter

@filter.setter
def filter(value: Callable[[TimeseriesDataTimestamp], bool])

Sets the custom function used to filter incoming data before adding it to the buffer.

If the function returns True, the data is added to the buffer; otherwise, it is not. If not set, defaults to None (disabled).

Arguments:

  • value - The custom filter function or None to disable.

custom_trigger

@property
def custom_trigger() -> Callable[[TimeseriesData], bool]

Gets the custom function that is called after adding a new timestamp to the buffer.

If the function returns True, the buffer releases content and triggers relevant callbacks. If not set, defaults to None (disabled).

Returns:

Callable[[TimeseriesData], bool]: The custom trigger function or None if disabled.

custom_trigger

@custom_trigger.setter
def custom_trigger(value: Callable[[TimeseriesData], bool])

Sets the custom function that is called after adding a new timestamp to the buffer.

If the function returns True, the buffer releases content and triggers relevant callbacks. If not set, defaults to None (disabled).

Arguments:

  • value - The custom trigger function or None to disable.

get_net_pointer

def get_net_pointer() -> ctypes.c_void_p

Returns the .net pointer for the TimeseriesBufferConfiguration object.

Returns:

  • ctypes.c_void_p - The .net pointer for the TimeseriesBufferConfiguration object.

quixstreams.models.timeseriesdata

TimeseriesData Objects

@nativedecorator
class TimeseriesData(object)

Describes timeseries data for multiple timestamps.

__init__

def __init__(net_pointer: ctypes.c_void_p = None)

Initializes a new instance of TimeseriesData.

Arguments:

  • net_pointer - Pointer to an instance of a .net TimeseriesData.

clone

def clone(parameter_filter: Optional[List[str]] = None)

Initializes a new instance of timeseries data with parameters matching the filter if one is provided.

Arguments:

  • parameter_filter - The parameter filter. If one is provided, only parameters present in the list will be cloned.

Returns:

  • TimeseriesData - A new instance of TimeseriesData with filtered parameters.

add_timestamp

def add_timestamp(time: Union[datetime, timedelta]) -> TimeseriesDataTimestamp

Start adding a new set of parameters and their tags at the specified time.

Arguments:

  • time - The time to use for adding new event values. | datetime: The datetime to use for adding new event values. Epoch will never be added to this | timedelta: The time since the default epoch to add the event values at

Returns:

  • TimeseriesDataTimestamp - A new TimeseriesDataTimestamp instance.

add_timestamp_milliseconds

def add_timestamp_milliseconds(milliseconds: int) -> TimeseriesDataTimestamp

Start adding a new set of parameters and their tags at the specified time.

Arguments:

  • milliseconds - The time in milliseconds since the default epoch to add the event values at.

Returns:

  • TimeseriesDataTimestamp - A new TimeseriesDataTimestamp instance.

add_timestamp_nanoseconds

def add_timestamp_nanoseconds(nanoseconds: int) -> TimeseriesDataTimestamp

Start adding a new set of parameters and their tags at the specified time.

Arguments:

  • nanoseconds - The time in nanoseconds since the default epoch to add the event values at.

Returns:

  • TimeseriesDataTimestamp - A new TimeseriesDataTimestamp instance.

timestamps

@property
def timestamps() -> List[TimeseriesDataTimestamp]

Gets the data as rows of TimeseriesDataTimestamp.

Returns:

  • List[TimeseriesDataTimestamp] - A list of TimeseriesDataTimestamp instances.

timestamps

@timestamps.setter
def timestamps(timestamp_list: List[TimeseriesDataTimestamp]) -> None

Sets the data as rows of TimeseriesDataTimestamp.

Arguments:

  • timestamp_list - A list of TimeseriesDataTimestamp instances to set.

to_dataframe

def to_dataframe() -> pd.DataFrame

Converts TimeseriesData to pandas DataFrame.

Returns:

  • pd.DataFrame - Converted pandas DataFrame.

from_panda_dataframe

@staticmethod
def from_panda_dataframe(data_frame: pd.DataFrame,
                         epoch: int = 0) -> 'TimeseriesData'

Converts pandas DataFrame to TimeseriesData.

Arguments:

  • data_frame - The pandas DataFrame to convert to TimeseriesData.
  • epoch - The epoch to add to each time value when converting to TimeseriesData. Defaults to 0.

Returns:

  • TimeseriesData - Converted TimeseriesData instance.

get_net_pointer

def get_net_pointer() -> ctypes.c_void_p

Gets the .net pointer of the current instance.

Returns:

  • ctypes.c_void_p - The .net pointer of the current instance

quixstreams.models.timeseriesdataraw

TimeseriesDataRaw Objects

@nativedecorator
class TimeseriesDataRaw(object)

Describes timeseries data in a raw format for multiple timestamps. Class is intended for read only.

__init__

def __init__(net_pointer: ctypes.c_void_p = None)

Initializes a new instance of TimeseriesDataRaw.

Arguments:

  • net_pointer - Pointer to an instance of a .net TimeseriesDataRaw. Defaults to None.

to_dataframe

def to_dataframe() -> pd.DataFrame

Converts TimeseriesDataRaw to pandas DataFrame.

Returns:

  • pd.DataFrame - Converted pandas DataFrame.

from_dataframe

@staticmethod
def from_dataframe(data_frame: pd.DataFrame,
                   epoch: int = 0) -> 'TimeseriesDataRaw'

Converts from pandas DataFrame to TimeseriesDataRaw.

Arguments:

  • data_frame - The pandas DataFrame to convert to TimeseriesData.
  • epoch - The epoch to add to each time value when converting to TimeseriesData. Defaults to 0.

Returns:

  • TimeseriesDataRaw - Converted TimeseriesDataRaw.

set_values

def set_values(epoch: int, timestamps: List[int],
               numeric_values: Dict[str, List[float]],
               string_values: Dict[str, List[str]],
               binary_values: Dict[str,
                                   List[bytes]], tag_values: Dict[str,
                                                                  List[str]])

Sets the values of the timeseries data from the provided dictionaries. Dictionary values are matched by index to the provided timestamps.

Arguments:

  • epoch - The time from which all timestamps are measured from.
  • timestamps - The timestamps of values in nanoseconds since epoch as an array.
  • numeric_values - The numeric values where the dictionary key is the parameter name and the value is the array of values.
  • string_values - The string values where the dictionary key is the parameter name and the value is the array of values.
  • binary_values - The binary values where the dictionary key is the parameter name and the value is the array of values.
  • tag_values - The tag values where the dictionary key is the parameter name and the value is the array of values.

epoch

@property
def epoch() -> int

The Unix epoch from which all other timestamps in this model are measured, in nanoseconds.

Returns:

  • int - The Unix epoch (01/01/1970) in nanoseconds.

timestamps

@property
def timestamps() -> List[int]

The timestamps of values in nanoseconds since the epoch. Timestamps are matched by index to numeric_values, string_values, binary_values, and tag_values.

Returns:

  • List[int] - A list of timestamps in nanoseconds since the epoch.

numeric_values

@property
def numeric_values() -> Dict[str, List[Optional[float]]]

The numeric values for parameters. The key is the parameter ID the values belong to. The value is the numerical values of the parameter. Values are matched by index to timestamps.

Returns:

Dict[str, List[Optional[float]]]: A dictionary mapping parameter IDs to lists of numerical values.

string_values

@property
def string_values() -> Dict[str, List[str]]

The string values for parameters. The key is the parameter ID the values belong to. The value is the string values of the parameter. Values are matched by index to timestamps.

Returns:

Dict[str, List[str]]: A dictionary mapping parameter IDs to lists of string values

binary_values

@property
def binary_values() -> Dict[str, List[bytes]]

The binary values for parameters. The key is the parameter ID the values belong to. The value is the binary values of the parameter. Values are matched by index to timestamps.

Returns:

Dict[str, List[bytes]]: A dictionary mapping parameter IDs to lists of bytes values

tag_values

@property
def tag_values() -> Dict[str, List[str]]

The tag values for parameters. The key is the parameter ID the values belong to. The value is the tag values of the parameter. Values are matched by index to timestamps.

Returns:

Dict[str, List[str]]: A dictionary mapping parameter IDs to lists of string values

convert_to_timeseriesdata

def convert_to_timeseriesdata() -> TimeseriesData

Converts TimeseriesDataRaw to TimeseriesData

quixstreams.models.timeseriesdatatimestamp

TimeseriesDataTimestamp Objects

@nativedecorator
class TimeseriesDataTimestamp()

Represents a single point in time with parameter values and tags attached to that time.

__init__

def __init__(net_pointer: ctypes.c_void_p)

Initializes a new instance of TimeseriesDataTimestamp.

Arguments:

  • net_pointer - Pointer to an instance of a .net TimeseriesDataTimestamp.

parameters

@property
def parameters() -> Dict[str, ParameterValue]

Gets the parameter values for the timestamp as a dictionary. If a key is not found, returns an empty ParameterValue.

Returns:

Dict[str, ParameterValue]: A dictionary with parameter id as key and ParameterValue as value.

tags

@property
def tags() -> Dict[str, str]

Gets the tags for the timestamp as a dictionary.

Returns:

Dict[str, str]: A dictionary with tag id as key and tag value as value.

timestamp_nanoseconds

@property
def timestamp_nanoseconds() -> int

Gets the timestamp in nanoseconds.

Returns:

  • int - The timestamp in nanoseconds.

timestamp_milliseconds

@property
def timestamp_milliseconds() -> int

Gets the timestamp in milliseconds.

Returns:

  • int - The timestamp in milliseconds.

timestamp

@property
def timestamp() -> datetime

Gets the timestamp in datetime format.

Returns:

  • datetime - The timestamp in datetime format.

timestamp_as_time_span

@property
def timestamp_as_time_span() -> timedelta

Gets the timestamp in timespan format.

Returns:

  • timedelta - The timestamp in timespan format.

add_value

def add_value(
    parameter_id: str, value: Union[numbers.Number, str, bytearray, bytes]
) -> 'TimeseriesDataTimestamp'

Adds a new value for the specified parameter.

Arguments:

  • parameter_id - The parameter id to add the value for.
  • value - The value to add. Can be a number, string, bytearray, or bytes.

Returns:

  • TimeseriesDataTimestamp - The updated TimeseriesDataTimestamp instance.

remove_value

def remove_value(parameter_id: str) -> 'TimeseriesDataTimestamp'

Removes the value for the specified parameter.

Arguments:

  • parameter_id - The parameter id to remove the value for.

Returns:

  • TimeseriesDataTimestamp - The updated TimeseriesDataTimestamp instance.

add_tag

def add_tag(tag_id: str, tag_value: str) -> 'TimeseriesDataTimestamp'

Adds a tag to the timestamp.

Arguments:

  • tag_id - The id of the tag to add.
  • tag_value - The value of the tag to add.

Returns:

  • TimeseriesDataTimestamp - The updated TimeseriesDataTimestamp instance.

remove_tag

def remove_tag(tag_id: str) -> 'TimeseriesDataTimestamp'

Removes a tag from the timestamp.

Arguments:

  • tag_id - The id of the tag to remove.

Returns:

  • TimeseriesDataTimestamp - The updated TimeseriesDataTimestamp instance.

add_tags

def add_tags(tags: Dict[str, str]) -> 'TimeseriesDataTimestamp'

Copies the tags from the specified dictionary. Conflicting tags will be overwritten.

Arguments:

  • tags - The dictionary of tags to add, with tag id as key and tag value as value.

Returns:

  • TimeseriesDataTimestamp - The updated TimeseriesDataTimestamp instance.

get_net_pointer

def get_net_pointer() -> ctypes.c_void_p

Gets the .net pointer of the TimeseriesDataTimestamp instance.

Returns:

  • ctypes.c_void_p - The .net pointer of the TimeseriesDataTimestamp instance.

quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Array

Array Objects

class Array()

ReadBlittables

@staticmethod
def ReadBlittables(array_uptr: ctypes.c_void_p,
                   valuetype,
                   valuemapper=None) -> []

Reads blittable values starting from the array pointer using the specified type and mapper then frees the pointer

Arguments:

  • array_uptr: Unmanaged memory pointer to the first element of the array.
  • valuetype: Type of the value
  • valuemapper: Conversion function for the value

Returns:

The converted array to the given type using the mapper

WriteBlittables

@staticmethod
def WriteBlittables(blittables: [any],
                    valuetype,
                    valuemapper=None) -> c_void_p

Writes a list of blittables (like int) into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

ReadArray

@staticmethod
def ReadArray(array_uptr: ctypes.c_void_p,
              valuemapper: Callable[[c_void_p], Any]) -> [[any]]

Reads from unmanaged memory, returning list of any sets (any[][])

WriteArray

@staticmethod
def WriteArray(values: [[any]], valuemapper: Callable[[Any],
                                                      c_void_p]) -> c_void_p

Writes an array of any sets (any[][]) into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

ReadNullables

@staticmethod
def ReadNullables(array_uptr: ctypes.c_void_p, nullable_type) -> [Any]

Parameters

array_ptr: c_void_p Pointer to .Net nullable array.

nullable_type: nullable type created by InteropUtils.create_nullable

Returns

[]: array of underlying type with possible None values

ReadLongs

@staticmethod
def ReadLongs(array_uptr: ctypes.c_void_p) -> [int]

Reads from unmanaged memory, returning list of int64

ReadLongsArray

@staticmethod
def ReadLongsArray(array_uptr: ctypes.c_void_p) -> [[int]]

Reads from unmanaged memory, returning list of int64 lists

WriteLongs

@staticmethod
def WriteLongs(longs: [int]) -> c_void_p

Writes list of int64 into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

WriteLongsArray

@staticmethod
def WriteLongsArray(longs_array: [[int]]) -> c_void_p

Writes list of int64 lists into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

ReadStrings

@staticmethod
def ReadStrings(array_uptr: ctypes.c_void_p) -> [str]

Reads from unmanaged memory, returning list of str

ReadStringsArray

@staticmethod
def ReadStringsArray(array_uptr: ctypes.c_void_p) -> [[str]]

Reads from unmanaged memory, returning list of str lists

WriteStrings

@staticmethod
def WriteStrings(strings: [str]) -> c_void_p

Writes list of str into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

WriteStringsArray

@staticmethod
def WriteStringsArray(strings_array: [[str]]) -> c_void_p

Writes list of str lists into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

ReadDoubles

@staticmethod
def ReadDoubles(array_uptr: ctypes.c_void_p) -> [float]

Reads from unmanaged memory, returning list of double (float)

ReadDoublesArray

@staticmethod
def ReadDoublesArray(array_uptr: ctypes.c_void_p) -> [[float]]

Reads from unmanaged memory, returning list of double (float) lists

WriteDoubles

@staticmethod
def WriteDoubles(doubles: [float]) -> c_void_p

Writes list of double (float) into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

WriteDoublesArray

@staticmethod
def WriteDoublesArray(doubles_array: [[float]]) -> c_void_p

Writes list of double (float) lists into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

ReadPointers

@staticmethod
def ReadPointers(pointers: [c_void_p]) -> c_void_p

Reads from unmanaged memory, returning list of pointers

ReadPointersArray

@staticmethod
def ReadPointersArray(array_uptr: ctypes.c_void_p) -> [[c_void_p]]

Reads from unmanaged memory, returning list of pointer lists

WritePointers

@staticmethod
def WritePointers(pointers: [c_void_p]) -> c_void_p

Writes list of pointer into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

WritePointersArray

@staticmethod
def WritePointersArray(pointers_array: [[c_void_p]]) -> c_void_p

Writes list of pointer lists into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

ReadBytes

@staticmethod
def ReadBytes(array_uptr: ctypes.c_void_p) -> bytes

Reads from unmanaged memory, returning bytes

ReadBytesArray

@staticmethod
def ReadBytesArray(array_uptr: ctypes.c_void_p) -> [bytes]

Reads from unmanaged memory, returning list of bytes

WriteBytes

@staticmethod
def WriteBytes(bytes_value: Union[bytes, bytearray]) -> c_void_p

Writes list of bytes into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

WriteBytesArray

@staticmethod
def WriteBytesArray(
        bytes_array: Union[List[bytes], List[bytearray]]) -> c_void_p

Writes list of bytes into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

ReadNullableDoubles

@staticmethod
def ReadNullableDoubles(array_uptr: ctypes.c_void_p) -> [Optional[float]]

Reads from unmanaged memory, returning list of Optional[float]

ReadNullableDoublesArray

@staticmethod
def ReadNullableDoublesArray(
        array_uptr: ctypes.c_void_p) -> [[Optional[float]]]

Reads from unmanaged memory, returning list of Optional[float] lists

WriteNullableDoubles

@staticmethod
def WriteNullableDoubles(nullable_doubles: [Optional[float]]) -> c_void_p

Writes list of Optional[float] into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

WriteNullableDoublesArray

@staticmethod
def WriteNullableDoublesArray(
        nullable_doubles_array: [[Optional[float]]]) -> c_void_p

Writes list of int64 lists into unmanaged memory, returning a pointer to the array, where first 4 bytes is the length

quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Collection

quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Dictionary

Dictionary Objects

class Dictionary()

ReadAnyHPtrToUPtr

@staticmethod
def ReadAnyHPtrToUPtr(dictionary_hptr: c_void_p) -> c_void_p

Read any dictionary that implements IEnumerable<KeyValuePair<,>>. Useful for dictionaries that do not implement

IDictionary, such as ReadOnlyDictionary

Arguments:

  • dictionary_hptr: Handler pointer to a dictionary

Returns:

Pointer to array with elements [c_void_p, c_void_p] where first is the key array, 2nd is the value array

WriteBlittables

@staticmethod
def WriteBlittables(dictionary: Dict[any, any], key_converter,
                    value_converter) -> c_void_p

Writes dictionary into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix

ReadBlittables

@staticmethod
def ReadBlittables(dict_uptr: c_void_p, key_converter,
                   value_converter) -> c_void_p

Read a pointer into a managed dictionary. The pointer must be to a structure [[keys],[values]], each array with a 4 byte length prefix

WriteStringPointers

@staticmethod
def WriteStringPointers(dictionary: Dict[str, c_void_p]) -> c_void_p

Writes dictionary of [str, c_void_p] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix

ReadStringPointers

@staticmethod
def ReadStringPointers(dictionary_uptr: c_void_p,
                       valuemapper=None) -> Dict[str, c_void_p]

Writes dictionary of [str, c_void_p] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix

WriteStringDoublesArray

@staticmethod
def WriteStringDoublesArray(dictionary: Dict[str, List[float]]) -> c_void_p

Writes dictionary of [str, [float]] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix

ReadStringDoublesArray

@staticmethod
def ReadStringDoublesArray(dictionary: Dict[str, List[int]]) -> c_void_p

Reads unmanaged memory at address, converting it to managed [str, float[]] dictionary

WriteStringLongsArray

@staticmethod
def WriteStringLongsArray(dictionary: Dict[str, List[int]]) -> c_void_p

Writes dictionary of [str, [int64]] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix

ReadStringLongsArray

@staticmethod
def ReadStringLongsArray(dictionary: Dict[str, List[int]]) -> c_void_p

Reads unmanaged memory at address, converting it to managed [str, int64p[]] dictionary

WriteStringStrings

@staticmethod
def WriteStringStrings(dictionary: Dict[str, str]) -> c_void_p

Writes dictionary of [str, str] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix

ReadStringStrings

@staticmethod
def ReadStringStrings(dictionary: Dict[str, str]) -> c_void_p

Reads unmanaged memory at address, converting it to managed [str, str] dictionary

WriteStringStringsArray

@staticmethod
def WriteStringStringsArray(dictionary: Dict[str, List[str]]) -> c_void_p

Writes dictionary of [str, [str]] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix

ReadStringStringsArray

@staticmethod
def ReadStringStringsArray(dictionary: Dict[str, List[str]]) -> c_void_p

Reads unmanaged memory at address, converting it to managed [str, str[]] dictionary

WriteStringBytesArray

@staticmethod
def WriteStringBytesArray(dictionary: Dict[str, List[bytes]]) -> c_void_p

Writes dictionary of [str, [bytes]] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix

ReadStringBytesArray

@staticmethod
def ReadStringBytesArray(dictionary: Dict[str, List[bytes]]) -> c_void_p

Reads unmanaged memory at address, converting it to managed [str, [bytes]] dictionary

WriteStringNullableDoublesArray

@staticmethod
def WriteStringNullableDoublesArray(
        dictionary: Dict[str, List[Optional[float]]]) -> c_void_p

Writes dictionary of [str, [Optional[float]]] into unmanaged memory, returning a pointer with structure [[keys],[values]], each array with a 4 byte length prefix

ReadStringNullableDoublesArray

@staticmethod
def ReadStringNullableDoublesArray(
        dictionary: Dict[str, List[Optional[Optional[float]]]]) -> c_void_p

Reads unmanaged memory at address, converting it to managed [str, float[]] dictionary

quixstreams.native.Python.InteropHelpers.ExternalTypes.System.Enumerable

Enumerable Objects

class Enumerable()

ReadAny

@staticmethod
def ReadAny(enumerable_hptr: c_void_p) -> c_void_p

Read any object that implements IEnumerable. Useful for cases when other enumerable methods don't fulfill the

the role in a more efficient manner

Arguments:

  • enumerable_hptr: Handler pointer to an object

Returns:

Handle pointer to an array of values which depend on the underlying value types

quixstreams.native.Python.InteropHelpers.ExternalTypes.System.List

quixstreams.native.Python.InteropHelpers.InteropUtils

InteropUtils Objects

class InteropUtils(object)

set_exception_callback

@staticmethod
def set_exception_callback(callback: Callable[[InteropException], None])

Sets the exception handler for interop exceptions

callback: Callable[[InteropException], None] The callback which takes InteropException and returns nothing

log_debug

@staticmethod
def log_debug(message: str)

Logs debug message if debugging is enabled

message: str The message to log

enable_debug

@staticmethod
def enable_debug()

Enables Debugging logs

disable_debug

@staticmethod
def disable_debug()

Enables Debugging logs

pin_hptr_target

@staticmethod
def pin_hptr_target(hptr: c_void_p) -> c_void_p

Creates a GC Handle with pinned type. Use get_pin_address to acquire the pinned resources's address Must be freed as soon as possible with free_hptr

Parameters

hptr: c_void_p Pointer to .Net GC Handle

Returns

c_void_p: .Net pointer to the value

get_pin_address

@staticmethod
def get_pin_address(hptr: c_void_p) -> c_void_p

Retrieves the address of the pinned resource from the provided GC Handle ptr

Parameters

hptr: c_void_p Pointer to .Net pinned GC Handle

Returns

c_void_p: memory address of the underlying resource

free_hptr

@staticmethod
def free_hptr(hptr: c_void_p) -> None

Frees the provided GC Handle

Parameters

hptr: c_void_p Pointer to .Net GC Handle

free_uptr

@staticmethod
def free_uptr(uptr: c_void_p) -> None

Frees the provided unmanaged pointer

Parameters

uptr: c_void_p Unmanaged pointer

allocate_uptr

@staticmethod
def allocate_uptr(size: int) -> c_void_p

Allocated unmanaged memory pointer of the desired size

Parameters

size: c_void_p The desired size of the memory

Returns

c_void_p: Unmanaged memory pointer

invoke_and_free

@staticmethod
def invoke_and_free(hptr: ctypes.c_void_p, func, *args, **kwargs)

Invokes a function where first positional argument is a c# GC Handle pointer (hptr), then disposes it

Parameters

hptr: ctypes.c_void_p c# GC Handle pointer (hptr)

func: callable function where first arg is the hptr

Returns

Any: the function result

dict_nullables

TODO Should I lock on this?

create_nullable

@staticmethod
def create_nullable(underlying_ctype)

Create a nullable type that is equivalent for serialization purposes to a nullable c# type in places where it is serialized as a struct. In this case byte prefix is added equivalent to minimum addressable memory size according to cpu architecture. For example a nullable double on 64 bit would be 8 bytes for boolean and 8 bytes for double.

Parameters

underlying_ctype: type defined by ctypes such as ctypes.c_double

dict_mem_nullables

TODO Should I lock on this?

create_mem_nullable

@staticmethod
def create_mem_nullable(underlying_ctype)

Create a nullable type that is equivalent for serialization purposes to a nullable c# type in places where it is not serialized as a struct, but rather as a continuous memory segment to pointed at by either a pointer or array. In this case 1 byte prefix is added kept for the boolean flag rather than the min addressable memory size according to cpu architecture. For example a nullable double on 64 bit would be 1 byte for boolean and 8 bytes for double.

Parameters

underlying_ctype: type defined by ctypes such as ctypes.c_double

quixstreams.native.Python.MicrosoftExtensionsLoggingAbstractions.Microsoft.Extensions.Logging.LogLevel

quixstreams.native.Python.QuixStreamsState.StateValue

StateValue Objects

class StateValue(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StateValue

Returns

StateValue: Instance wrapping the .net type StateValue

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StateValue

Returns

StateValue: Instance wrapping the .net type StateValue

Constructor

@staticmethod
def Constructor(value: bool) -> c_void_p

Parameters

value: bool Underlying .Net type is Boolean

Returns

c_void_p: GC Handle Pointer to .Net type StateValue

Constructor2

@staticmethod
def Constructor2(value: int) -> c_void_p

Parameters

value: int Underlying .Net type is long

Returns

c_void_p: GC Handle Pointer to .Net type StateValue

Constructor3

@staticmethod
def Constructor3(value: c_void_p) -> c_void_p

Parameters

value: c_void_p GC Handle Pointer to .Net type byte[]

Returns

c_void_p: GC Handle Pointer to .Net type StateValue

Constructor4

@staticmethod
def Constructor4(value: c_void_p, type: StateType) -> c_void_p

Parameters

value: c_void_p GC Handle Pointer to .Net type byte[]

type: StateType Underlying .Net type is StateValue.StateType

Returns

c_void_p: GC Handle Pointer to .Net type StateValue

Constructor5

@staticmethod
def Constructor5(value: str) -> c_void_p

Parameters

value: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type StateValue

Constructor6

@staticmethod
def Constructor6(value: float) -> c_void_p

Parameters

value: float Underlying .Net type is double

Returns

c_void_p: GC Handle Pointer to .Net type StateValue

get_Type

def get_Type() -> StateType

Parameters

Returns

StateType: Underlying .Net type is StateValue.StateType

get_DoubleValue

def get_DoubleValue() -> float

Parameters

Returns

float: Underlying .Net type is double

get_LongValue

def get_LongValue() -> int

Parameters

Returns

int: Underlying .Net type is long

get_StringValue

def get_StringValue() -> str

Parameters

Returns

str: Underlying .Net type is string

get_BoolValue

def get_BoolValue() -> bool

Parameters

Returns

bool: Underlying .Net type is Boolean

get_BinaryValue

def get_BinaryValue() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type byte[]

Equals

def Equals(other: c_void_p) -> bool

Parameters

other: c_void_p GC Handle Pointer to .Net type StateValue

Returns

bool: Underlying .Net type is Boolean

quixstreams.native.Python.QuixStreamsState.StateValue_StateType

quixstreams.native.Python.QuixStreamsState.Storage.FileStorage.LocalFileStorage.LocalFileStorage

LocalFileStorage Objects

class LocalFileStorage(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type LocalFileStorage

Returns

LocalFileStorage: Instance wrapping the .net type LocalFileStorage

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type LocalFileStorage

Returns

LocalFileStorage: Instance wrapping the .net type LocalFileStorage

Constructor

@staticmethod
def Constructor(storageDirectory: str = None,
                autoCreateDir: bool = True) -> c_void_p

Parameters

storageDirectory: str (Optional) Underlying .Net type is string. Defaults to None

autoCreateDir: bool (Optional) Underlying .Net type is Boolean. Defaults to True

Returns

c_void_p: GC Handle Pointer to .Net type LocalFileStorage

quixstreams.native.Python.QuixStreamsState.Storage.IStateStorage

IStateStorage Objects

class IStateStorage(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type IStateStorage

Returns

IStateStorage: Instance wrapping the .net type IStateStorage

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type IStateStorage

Returns

IStateStorage: Instance wrapping the .net type IStateStorage

quixstreams.native.Python.QuixStreamsState.Storage.StorageExtensions

StorageExtensions Objects

class StorageExtensions(object)

Set

@staticmethod
def Set(stateStorage: c_void_p, key: str, value: int) -> None

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

value: int Underlying .Net type is long

Returns

None: Underlying .Net type is void

Set2

@staticmethod
def Set2(stateStorage: c_void_p, key: str, value: float) -> None

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

value: float Underlying .Net type is double

Returns

None: Underlying .Net type is void

Set3

@staticmethod
def Set3(stateStorage: c_void_p, key: str, value: str) -> None

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

value: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

Set4

@staticmethod
def Set4(stateStorage: c_void_p, key: str, value: c_void_p) -> None

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

value: c_void_p GC Handle Pointer to .Net type byte[]

Returns

None: Underlying .Net type is void

Set5

@staticmethod
def Set5(stateStorage: c_void_p, key: str, value: bool) -> None

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

value: bool Underlying .Net type is Boolean

Returns

None: Underlying .Net type is void

Set6

@staticmethod
def Set6(stateStorage: c_void_p, key: str, value: c_void_p) -> None

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

value: c_void_p GC Handle Pointer to .Net type StateValue

Returns

None: Underlying .Net type is void

Get

@staticmethod
def Get(stateStorage: c_void_p, key: str) -> c_void_p

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type StateValue

GetDouble

@staticmethod
def GetDouble(stateStorage: c_void_p, key: str) -> float

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

Returns

float: Underlying .Net type is double

GetString

@staticmethod
def GetString(stateStorage: c_void_p, key: str) -> str

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

Returns

str: Underlying .Net type is string

GetBool

@staticmethod
def GetBool(stateStorage: c_void_p, key: str) -> bool

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

Returns

bool: Underlying .Net type is Boolean

GetLong

@staticmethod
def GetLong(stateStorage: c_void_p, key: str) -> int

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

Returns

int: Underlying .Net type is long

GetBinary

@staticmethod
def GetBinary(stateStorage: c_void_p, key: str) -> c_void_p

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type byte[]

Remove

@staticmethod
def Remove(stateStorage: c_void_p, key: str) -> None

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

ContainsKey

@staticmethod
def ContainsKey(stateStorage: c_void_p, key: str) -> bool

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

key: str Underlying .Net type is string

Returns

bool: Underlying .Net type is Boolean

GetAllKeys

@staticmethod
def GetAllKeys(stateStorage: c_void_p) -> c_void_p

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

Returns

c_void_p: GC Handle Pointer to .Net type string[]

Clear

@staticmethod
def Clear(stateStorage: c_void_p) -> None

Parameters

stateStorage: c_void_p GC Handle Pointer to .Net type IStateStorage

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.App

App Objects

class App(object)

Run

@staticmethod
def Run(cancellationToken: c_void_p = None,
        beforeShutdown: Callable[[], None] = None) -> None

Parameters

cancellationToken: c_void_p (Optional) GC Handle Pointer to .Net type CancellationToken. Defaults to None

beforeShutdown: Callable[[], None] (Optional) Underlying .Net type is Action. Defaults to None

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Configuration.SaslMechanism

quixstreams.native.Python.QuixStreamsStreaming.Configuration.SecurityOptions

SecurityOptions Objects

class SecurityOptions(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type SecurityOptions

Returns

SecurityOptions: Instance wrapping the .net type SecurityOptions

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type SecurityOptions

Returns

SecurityOptions: Instance wrapping the .net type SecurityOptions

Constructor

@staticmethod
def Constructor() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type SecurityOptions

Constructor2

@staticmethod
def Constructor2(
        sslCertificates: str,
        username: str,
        password: str,
        saslMechanism: SaslMechanism = SaslMechanism.ScramSha256) -> c_void_p

Parameters

sslCertificates: str Underlying .Net type is string

username: str Underlying .Net type is string

password: str Underlying .Net type is string

saslMechanism: SaslMechanism (Optional) Underlying .Net type is SaslMechanism. Defaults to ScramSha256

Returns

c_void_p: GC Handle Pointer to .Net type SecurityOptions

get_SaslMechanism

def get_SaslMechanism() -> Optional[SaslMechanism]

Parameters

Returns

Optional[SaslMechanism]: Underlying .Net type is SaslMechanism?

set_SaslMechanism

def set_SaslMechanism(value: Optional[SaslMechanism]) -> None

Parameters

value: Optional[SaslMechanism] Underlying .Net type is SaslMechanism?

Returns

None: Underlying .Net type is void

get_Username

def get_Username() -> str

Parameters

Returns

str: Underlying .Net type is string

set_Username

def set_Username(value: str) -> None

Parameters

value: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

get_Password

def get_Password() -> str

Parameters

Returns

str: Underlying .Net type is string

set_Password

def set_Password(value: str) -> None

Parameters

value: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

get_SslCertificates

def get_SslCertificates() -> str

Parameters

Returns

str: Underlying .Net type is string

set_SslCertificates

def set_SslCertificates(value: str) -> None

Parameters

value: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

get_UseSsl

def get_UseSsl() -> bool

Parameters

Returns

bool: Underlying .Net type is Boolean

set_UseSsl

def set_UseSsl(value: bool) -> None

Parameters

value: bool Underlying .Net type is Boolean

Returns

None: Underlying .Net type is void

get_UseSasl

def get_UseSasl() -> bool

Parameters

Returns

bool: Underlying .Net type is Boolean

set_UseSasl

def set_UseSasl(value: bool) -> None

Parameters

value: bool Underlying .Net type is Boolean

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.IStreamConsumer

IStreamConsumer Objects

class IStreamConsumer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type IStreamConsumer

Returns

IStreamConsumer: Instance wrapping the .net type IStreamConsumer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type IStreamConsumer

Returns

IStreamConsumer: Instance wrapping the .net type IStreamConsumer

get_StreamId

def get_StreamId() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Properties

def get_Properties() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type StreamPropertiesConsumer

get_Timeseries

def get_Timeseries() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type StreamTimeseriesConsumer

get_Events

def get_Events() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type StreamEventsConsumer

add_OnPackageReceived

def add_OnPackageReceived(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnPackageReceived

def remove_OnPackageReceived(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnStreamClosed

def add_OnStreamClosed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnStreamClosed

def remove_OnStreamClosed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.IStreamProducer

IStreamProducer Objects

class IStreamProducer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type IStreamProducer

Returns

IStreamProducer: Instance wrapping the .net type IStreamProducer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type IStreamProducer

Returns

IStreamProducer: Instance wrapping the .net type IStreamProducer

get_StreamId

def get_StreamId() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Epoch

def get_Epoch() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type DateTime

set_Epoch

def set_Epoch(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type DateTime

Returns

None: Underlying .Net type is void

get_Properties

def get_Properties() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type StreamPropertiesProducer

get_Timeseries

def get_Timeseries() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type StreamTimeseriesProducer

get_Events

def get_Events() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type StreamEventsProducer

Flush

def Flush() -> None

Parameters

Returns

None: Underlying .Net type is void

Close

def Close(streamState: StreamEndType = StreamEndType.Closed) -> None

Parameters

streamState: StreamEndType (Optional) Underlying .Net type is StreamEndType. Defaults to Closed

Returns

None: Underlying .Net type is void

add_OnWriteException

def add_OnWriteException(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnWriteException

def remove_OnWriteException(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.ITopicConsumer

ITopicConsumer Objects

class ITopicConsumer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ITopicConsumer

Returns

ITopicConsumer: Instance wrapping the .net type ITopicConsumer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ITopicConsumer

Returns

ITopicConsumer: Instance wrapping the .net type ITopicConsumer

Subscribe

def Subscribe() -> None

Parameters

Returns

None: Underlying .Net type is void

add_OnStreamReceived

def add_OnStreamReceived(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnStreamReceived

def remove_OnStreamReceived(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnRevoking

def add_OnRevoking(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnRevoking

def remove_OnRevoking(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnStreamsRevoked

def add_OnStreamsRevoked(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnStreamsRevoked

def remove_OnStreamsRevoked(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnCommitted

def add_OnCommitted(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnCommitted

def remove_OnCommitted(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnCommitting

def add_OnCommitting(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnCommitting

def remove_OnCommitting(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

Commit

def Commit() -> None

Parameters

Returns

None: Underlying .Net type is void

add_OnDisposed

def add_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnDisposed

def remove_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.ITopicProducer

ITopicProducer Objects

class ITopicProducer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ITopicProducer

Returns

ITopicProducer: Instance wrapping the .net type ITopicProducer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ITopicProducer

Returns

ITopicProducer: Instance wrapping the .net type ITopicProducer

CreateStream

def CreateStream() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type IStreamProducer

CreateStream2

def CreateStream2(streamId: str) -> c_void_p

Parameters

streamId: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type IStreamProducer

GetStream

def GetStream(streamId: str) -> c_void_p

Parameters

streamId: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type IStreamProducer

GetOrCreateStream

def GetOrCreateStream(
        streamId: str,
        onStreamCreated: Callable[[c_void_p], None] = None) -> c_void_p

Parameters

streamId: str Underlying .Net type is string

onStreamCreated: Callable[[c_void_p], None] (Optional) Underlying .Net type is Action. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type IStreamProducer

add_OnDisposed

def add_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnDisposed

def remove_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.KafkaStreamingClient

KafkaStreamingClient Objects

class KafkaStreamingClient(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type KafkaStreamingClient

Returns

KafkaStreamingClient: Instance wrapping the .net type KafkaStreamingClient

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type KafkaStreamingClient

Returns

KafkaStreamingClient: Instance wrapping the .net type KafkaStreamingClient

Constructor

@staticmethod
def Constructor(brokerAddress: str,
                securityOptions: c_void_p = None,
                properties: c_void_p = None,
                debug: bool = False) -> c_void_p

Parameters

brokerAddress: str Underlying .Net type is string

securityOptions: c_void_p (Optional) GC Handle Pointer to .Net type SecurityOptions. Defaults to None

properties: c_void_p (Optional) GC Handle Pointer to .Net type IDictionary. Defaults to None

debug: bool (Optional) Underlying .Net type is Boolean. Defaults to False

Returns

c_void_p: GC Handle Pointer to .Net type KafkaStreamingClient

GetTopicConsumer

def GetTopicConsumer(
        topic: str,
        consumerGroup: str = None,
        options: c_void_p = None,
        autoOffset: AutoOffsetReset = AutoOffsetReset.Latest) -> c_void_p

Parameters

topic: str Underlying .Net type is string

consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None

options: c_void_p (Optional) GC Handle Pointer to .Net type CommitOptions. Defaults to None

autoOffset: AutoOffsetReset (Optional) Underlying .Net type is AutoOffsetReset. Defaults to Latest

Returns

c_void_p: GC Handle Pointer to .Net type ITopicConsumer

GetRawTopicConsumer

def GetRawTopicConsumer(
        topic: str,
        consumerGroup: str = None,
        autoOffset: Optional[AutoOffsetReset] = None) -> c_void_p

Parameters

topic: str Underlying .Net type is string

consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None

autoOffset: Optional[AutoOffsetReset] (Optional) Underlying .Net type is AutoOffsetReset?. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type IRawTopicConsumer

GetRawTopicProducer

def GetRawTopicProducer(topic: str) -> c_void_p

Parameters

topic: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type IRawTopicProducer

GetTopicProducer

def GetTopicProducer(topic: str) -> c_void_p

Parameters

topic: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type ITopicProducer

quixstreams.native.Python.QuixStreamsStreaming.KafkaStreamingClientExtensions

KafkaStreamingClientExtensions Objects

class KafkaStreamingClientExtensions(object)

GetTopicConsumer

@staticmethod
def GetTopicConsumer(
        client: c_void_p,
        topic: str,
        consumerGroup: str = None,
        commitMode: CommitMode = CommitMode.Automatic,
        autoOffset: AutoOffsetReset = AutoOffsetReset.Latest) -> c_void_p

Parameters

client: c_void_p GC Handle Pointer to .Net type KafkaStreamingClient

topic: str Underlying .Net type is string

consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None

commitMode: CommitMode (Optional) Underlying .Net type is CommitMode. Defaults to Automatic

autoOffset: AutoOffsetReset (Optional) Underlying .Net type is AutoOffsetReset. Defaults to Latest

Returns

c_void_p: GC Handle Pointer to .Net type ITopicConsumer

quixstreams.native.Python.QuixStreamsStreaming.Models.CommitMode

quixstreams.native.Python.QuixStreamsStreaming.Models.EventData

EventData Objects

class EventData(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventData

Returns

EventData: Instance wrapping the .net type EventData

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventData

Returns

EventData: Instance wrapping the .net type EventData

Constructor

@staticmethod
def Constructor(eventId: str, timestampNanoseconds: int,
                eventValue: str) -> c_void_p

Parameters

eventId: str Underlying .Net type is string

timestampNanoseconds: int Underlying .Net type is long

eventValue: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type EventData

Constructor2

@staticmethod
def Constructor2(eventId: str, timestamp: c_void_p,
                 eventValue: str) -> c_void_p

Parameters

eventId: str Underlying .Net type is string

timestamp: c_void_p GC Handle Pointer to .Net type DateTime

eventValue: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type EventData

Constructor3

@staticmethod
def Constructor3(eventId: str, timestamp: c_void_p,
                 eventValue: str) -> c_void_p

Parameters

eventId: str Underlying .Net type is string

timestamp: c_void_p GC Handle Pointer to .Net type TimeSpan

eventValue: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type EventData

Clone

def Clone() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type EventData

get_Id

def get_Id() -> str

Parameters

Returns

str: Underlying .Net type is string

set_Id

def set_Id(value: str) -> None

Parameters

value: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

get_Value

def get_Value() -> str

Parameters

Returns

str: Underlying .Net type is string

set_Value

def set_Value(value: str) -> None

Parameters

value: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

get_Tags

def get_Tags() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type IDictionary

AddTag

def AddTag(tagId: str, tagValue: str) -> c_void_p

Parameters

tagId: str Underlying .Net type is string

tagValue: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type EventData

AddTags

def AddTags(tags: c_void_p) -> c_void_p

Parameters

tags: c_void_p GC Handle Pointer to .Net type IEnumerable>

Returns

c_void_p: GC Handle Pointer to .Net type EventData

RemoveTag

def RemoveTag(tagId: str) -> c_void_p

Parameters

tagId: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type EventData

get_TimestampNanoseconds

def get_TimestampNanoseconds() -> int

Parameters

Returns

int: Underlying .Net type is long

get_TimestampMilliseconds

def get_TimestampMilliseconds() -> int

Parameters

Returns

int: Underlying .Net type is long

get_Timestamp

def get_Timestamp() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type DateTime

get_TimestampAsTimeSpan

def get_TimestampAsTimeSpan() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type TimeSpan

quixstreams.native.Python.QuixStreamsStreaming.Models.EventDefinition

EventDefinition Objects

class EventDefinition(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinition

Returns

EventDefinition: Instance wrapping the .net type EventDefinition

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinition

Returns

EventDefinition: Instance wrapping the .net type EventDefinition

Constructor

@staticmethod
def Constructor() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type EventDefinition

get_Id

def get_Id() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Name

def get_Name() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Description

def get_Description() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Location

def get_Location() -> str

Parameters

Returns

str: Underlying .Net type is string

get_CustomProperties

def get_CustomProperties() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Level

def get_Level() -> EventLevel

Parameters

Returns

EventLevel: Underlying .Net type is EventLevel

quixstreams.native.Python.QuixStreamsStreaming.Models.ParameterDefinition

ParameterDefinition Objects

class ParameterDefinition(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinition

Returns

ParameterDefinition: Instance wrapping the .net type ParameterDefinition

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinition

Returns

ParameterDefinition: Instance wrapping the .net type ParameterDefinition

Constructor

@staticmethod
def Constructor() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type ParameterDefinition

get_Id

def get_Id() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Name

def get_Name() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Description

def get_Description() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Location

def get_Location() -> str

Parameters

Returns

str: Underlying .Net type is string

get_MinimumValue

def get_MinimumValue() -> Optional[float]

Parameters

Returns

Optional[float]: Underlying .Net type is double?

get_MaximumValue

def get_MaximumValue() -> Optional[float]

Parameters

Returns

Optional[float]: Underlying .Net type is double?

get_Unit

def get_Unit() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Format

def get_Format() -> str

Parameters

Returns

str: Underlying .Net type is string

get_CustomProperties

def get_CustomProperties() -> str

Parameters

Returns

str: Underlying .Net type is string

quixstreams.native.Python.QuixStreamsStreaming.Models.ParameterValue

ParameterValue Objects

class ParameterValue(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ParameterValue

Returns

ParameterValue: Instance wrapping the .net type ParameterValue

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ParameterValue

Returns

ParameterValue: Instance wrapping the .net type ParameterValue

get_ParameterId

def get_ParameterId() -> str

Parameters

Returns

str: Underlying .Net type is string

get_NumericValue

def get_NumericValue() -> Optional[float]

Parameters

Returns

Optional[float]: Underlying .Net type is double?

set_NumericValue

def set_NumericValue(value: Optional[float]) -> None

Parameters

value: Optional[float] Underlying .Net type is double?

Returns

None: Underlying .Net type is void

get_StringValue

def get_StringValue() -> str

Parameters

Returns

str: Underlying .Net type is string

set_StringValue

def set_StringValue(value: str) -> None

Parameters

value: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

get_BinaryValue

def get_BinaryValue() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type byte[]

set_BinaryValue

def set_BinaryValue(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type byte[]

Returns

None: Underlying .Net type is void

get_Value

def get_Value() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type Object

op_Equality

@staticmethod
def op_Equality(lhs: c_void_p, rhs: c_void_p) -> bool

Parameters

lhs: c_void_p GC Handle Pointer to .Net type ParameterValue

rhs: c_void_p GC Handle Pointer to .Net type ParameterValue

Returns

bool: Underlying .Net type is Boolean

op_Inequality

@staticmethod
def op_Inequality(lhs: c_void_p, rhs: c_void_p) -> bool

Parameters

lhs: c_void_p GC Handle Pointer to .Net type ParameterValue

rhs: c_void_p GC Handle Pointer to .Net type ParameterValue

Returns

bool: Underlying .Net type is Boolean

Equals

def Equals(obj: c_void_p) -> bool

Parameters

obj: c_void_p GC Handle Pointer to .Net type Object

Returns

bool: Underlying .Net type is Boolean

GetHashCode

def GetHashCode() -> int

Parameters

Returns

int: Underlying .Net type is int

ToString

def ToString() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Type

def get_Type() -> ParameterValueType

Parameters

Returns

ParameterValueType: Underlying .Net type is ParameterValueType

quixstreams.native.Python.QuixStreamsStreaming.Models.ParameterValueType

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.EventDataReadEventArgs

EventDataReadEventArgs Objects

class EventDataReadEventArgs(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventDataReadEventArgs

Returns

EventDataReadEventArgs: Instance wrapping the .net type EventDataReadEventArgs

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventDataReadEventArgs

Returns

EventDataReadEventArgs: Instance wrapping the .net type EventDataReadEventArgs

Constructor

@staticmethod
def Constructor(topicConsumer: c_void_p, consumer: c_void_p,
                data: c_void_p) -> c_void_p

Parameters

topicConsumer: c_void_p GC Handle Pointer to .Net type ITopicConsumer

consumer: c_void_p GC Handle Pointer to .Net type IStreamConsumer

data: c_void_p GC Handle Pointer to .Net type EventData

Returns

c_void_p: GC Handle Pointer to .Net type EventDataReadEventArgs

get_TopicConsumer

def get_TopicConsumer() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type ITopicConsumer

get_Stream

def get_Stream() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type IStreamConsumer

get_Data

def get_Data() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type EventData

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.EventDefinitionsChangedEventArgs

EventDefinitionsChangedEventArgs Objects

class EventDefinitionsChangedEventArgs(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinitionsChangedEventArgs

Returns

EventDefinitionsChangedEventArgs: Instance wrapping the .net type EventDefinitionsChangedEventArgs

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinitionsChangedEventArgs

Returns

EventDefinitionsChangedEventArgs: Instance wrapping the .net type EventDefinitionsChangedEventArgs

Constructor

@staticmethod
def Constructor(topicConsumer: c_void_p, consumer: c_void_p) -> c_void_p

Parameters

topicConsumer: c_void_p GC Handle Pointer to .Net type ITopicConsumer

consumer: c_void_p GC Handle Pointer to .Net type IStreamConsumer

Returns

c_void_p: GC Handle Pointer to .Net type EventDefinitionsChangedEventArgs

get_TopicConsumer

def get_TopicConsumer() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type ITopicConsumer

get_Stream

def get_Stream() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type IStreamConsumer

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.ParameterDefinitionsChangedEventArgs

ParameterDefinitionsChangedEventArgs Objects

class ParameterDefinitionsChangedEventArgs(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinitionsChangedEventArgs

Returns

ParameterDefinitionsChangedEventArgs: Instance wrapping the .net type ParameterDefinitionsChangedEventArgs

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinitionsChangedEventArgs

Returns

ParameterDefinitionsChangedEventArgs: Instance wrapping the .net type ParameterDefinitionsChangedEventArgs

Constructor

@staticmethod
def Constructor(topicConsumer: c_void_p, consumer: c_void_p) -> c_void_p

Parameters

topicConsumer: c_void_p GC Handle Pointer to .Net type ITopicConsumer

consumer: c_void_p GC Handle Pointer to .Net type IStreamConsumer

Returns

c_void_p: GC Handle Pointer to .Net type ParameterDefinitionsChangedEventArgs

get_TopicConsumer

def get_TopicConsumer() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type ITopicConsumer

get_Stream

def get_Stream() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type IStreamConsumer

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamEventsConsumer

StreamEventsConsumer Objects

class StreamEventsConsumer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamEventsConsumer

Returns

StreamEventsConsumer: Instance wrapping the .net type StreamEventsConsumer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamEventsConsumer

Returns

StreamEventsConsumer: Instance wrapping the .net type StreamEventsConsumer

add_OnDataReceived

def add_OnDataReceived(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnDataReceived

def remove_OnDataReceived(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnDefinitionsChanged

def add_OnDefinitionsChanged(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnDefinitionsChanged

def remove_OnDefinitionsChanged(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

get_Definitions

def get_Definitions() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type IList

Dispose

def Dispose() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamPropertiesChangedEventArgs

StreamPropertiesChangedEventArgs Objects

class StreamPropertiesChangedEventArgs(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesChangedEventArgs

Returns

StreamPropertiesChangedEventArgs: Instance wrapping the .net type StreamPropertiesChangedEventArgs

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesChangedEventArgs

Returns

StreamPropertiesChangedEventArgs: Instance wrapping the .net type StreamPropertiesChangedEventArgs

Constructor

@staticmethod
def Constructor(topicConsumer: c_void_p, consumer: c_void_p) -> c_void_p

Parameters

topicConsumer: c_void_p GC Handle Pointer to .Net type ITopicConsumer

consumer: c_void_p GC Handle Pointer to .Net type IStreamConsumer

Returns

c_void_p: GC Handle Pointer to .Net type StreamPropertiesChangedEventArgs

get_TopicConsumer

def get_TopicConsumer() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type ITopicConsumer

get_Stream

def get_Stream() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type IStreamConsumer

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamPropertiesConsumer

StreamPropertiesConsumer Objects

class StreamPropertiesConsumer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesConsumer

Returns

StreamPropertiesConsumer: Instance wrapping the .net type StreamPropertiesConsumer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesConsumer

Returns

StreamPropertiesConsumer: Instance wrapping the .net type StreamPropertiesConsumer

add_OnChanged

def add_OnChanged(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnChanged

def remove_OnChanged(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

get_Name

def get_Name() -> str

Parameters

Returns

str: Underlying .Net type is string

get_Location

def get_Location() -> str

Parameters

Returns

str: Underlying .Net type is string

get_TimeOfRecording

def get_TimeOfRecording() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type DateTime?

get_Metadata

def get_Metadata() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type Dictionary

get_Parents

def get_Parents() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type List

Dispose

def Dispose() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.StreamTimeseriesConsumer

StreamTimeseriesConsumer Objects

class StreamTimeseriesConsumer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamTimeseriesConsumer

Returns

StreamTimeseriesConsumer: Instance wrapping the .net type StreamTimeseriesConsumer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamTimeseriesConsumer

Returns

StreamTimeseriesConsumer: Instance wrapping the .net type StreamTimeseriesConsumer

CreateBuffer

def CreateBuffer(parametersFilter: c_void_p,
                 bufferConfiguration: c_void_p = None) -> c_void_p

Parameters

parametersFilter: c_void_p GC Handle Pointer to .Net type string[]

bufferConfiguration: c_void_p (Optional) GC Handle Pointer to .Net type TimeseriesBufferConfiguration. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesBufferConsumer

CreateBuffer2

def CreateBuffer2(parametersFilter: c_void_p) -> c_void_p

Parameters

parametersFilter: c_void_p GC Handle Pointer to .Net type string[]

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesBufferConsumer

add_OnDefinitionsChanged

def add_OnDefinitionsChanged(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnDefinitionsChanged

def remove_OnDefinitionsChanged(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnDataReceived

def add_OnDataReceived(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnDataReceived

def remove_OnDataReceived(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnRawReceived

def add_OnRawReceived(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnRawReceived

def remove_OnRawReceived(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

get_Definitions

def get_Definitions() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type List

Dispose

def Dispose() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.TimeseriesBufferConsumer

TimeseriesBufferConsumer Objects

class TimeseriesBufferConsumer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferConsumer

Returns

TimeseriesBufferConsumer: Instance wrapping the .net type TimeseriesBufferConsumer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferConsumer

Returns

TimeseriesBufferConsumer: Instance wrapping the .net type TimeseriesBufferConsumer

Dispose

def Dispose() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.TimeseriesDataRawReadEventArgs

TimeseriesDataRawReadEventArgs Objects

class TimeseriesDataRawReadEventArgs(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataRawReadEventArgs

Returns

TimeseriesDataRawReadEventArgs: Instance wrapping the .net type TimeseriesDataRawReadEventArgs

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataRawReadEventArgs

Returns

TimeseriesDataRawReadEventArgs: Instance wrapping the .net type TimeseriesDataRawReadEventArgs

Constructor

@staticmethod
def Constructor(topic: c_void_p, stream: c_void_p, data: c_void_p) -> c_void_p

Parameters

topic: c_void_p GC Handle Pointer to .Net type Object

stream: c_void_p GC Handle Pointer to .Net type Object

data: c_void_p GC Handle Pointer to .Net type TimeseriesDataRaw

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataRawReadEventArgs

get_Topic

def get_Topic() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type Object

get_Stream

def get_Stream() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type Object

get_Data

def get_Data() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataRaw

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamConsumer.TimeseriesDataReadEventArgs

TimeseriesDataReadEventArgs Objects

class TimeseriesDataReadEventArgs(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataReadEventArgs

Returns

TimeseriesDataReadEventArgs: Instance wrapping the .net type TimeseriesDataReadEventArgs

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataReadEventArgs

Returns

TimeseriesDataReadEventArgs: Instance wrapping the .net type TimeseriesDataReadEventArgs

Constructor

@staticmethod
def Constructor(topic: c_void_p, stream: c_void_p, data: c_void_p) -> c_void_p

Parameters

topic: c_void_p GC Handle Pointer to .Net type Object

stream: c_void_p GC Handle Pointer to .Net type Object

data: c_void_p GC Handle Pointer to .Net type TimeseriesData

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataReadEventArgs

get_Topic

def get_Topic() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type Object

get_Stream

def get_Stream() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type Object

get_Data

def get_Data() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesData

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.EventDataBuilder

EventDataBuilder Objects

class EventDataBuilder(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventDataBuilder

Returns

EventDataBuilder: Instance wrapping the .net type EventDataBuilder

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventDataBuilder

Returns

EventDataBuilder: Instance wrapping the .net type EventDataBuilder

Constructor

@staticmethod
def Constructor(streamEventsProducer: c_void_p,
                timestampNanoseconds: int) -> c_void_p

Parameters

streamEventsProducer: c_void_p GC Handle Pointer to .Net type StreamEventsProducer

timestampNanoseconds: int Underlying .Net type is long

Returns

c_void_p: GC Handle Pointer to .Net type EventDataBuilder

AddValue

def AddValue(eventId: str, value: str) -> c_void_p

Parameters

eventId: str Underlying .Net type is string

value: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type EventDataBuilder

AddTag

def AddTag(tagId: str, value: str) -> c_void_p

Parameters

tagId: str Underlying .Net type is string

value: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type EventDataBuilder

AddTags

def AddTags(tagsValues: c_void_p) -> c_void_p

Parameters

tagsValues: c_void_p GC Handle Pointer to .Net type IEnumerable>

Returns

c_void_p: GC Handle Pointer to .Net type EventDataBuilder

Publish

def Publish() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.EventDefinitionBuilder

EventDefinitionBuilder Objects

class EventDefinitionBuilder(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinitionBuilder

Returns

EventDefinitionBuilder: Instance wrapping the .net type EventDefinitionBuilder

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type EventDefinitionBuilder

Returns

EventDefinitionBuilder: Instance wrapping the .net type EventDefinitionBuilder

Constructor

@staticmethod
def Constructor(streamEventsProducer: c_void_p,
                location: str,
                properties: c_void_p = None) -> c_void_p

Parameters

streamEventsProducer: c_void_p GC Handle Pointer to .Net type StreamEventsProducer

location: str Underlying .Net type is string

properties: c_void_p (Optional) GC Handle Pointer to .Net type EventDefinition. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder

SetLevel

def SetLevel(level: EventLevel) -> c_void_p

Parameters

level: EventLevel Underlying .Net type is EventLevel

Returns

c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder

SetCustomProperties

def SetCustomProperties(customProperties: str) -> c_void_p

Parameters

customProperties: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder

AddDefinition

def AddDefinition(eventId: str,
                  name: str = None,
                  description: str = None) -> c_void_p

Parameters

eventId: str Underlying .Net type is string

name: str (Optional) Underlying .Net type is string. Defaults to None

description: str (Optional) Underlying .Net type is string. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.ParameterDefinitionBuilder

ParameterDefinitionBuilder Objects

class ParameterDefinitionBuilder(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinitionBuilder

Returns

ParameterDefinitionBuilder: Instance wrapping the .net type ParameterDefinitionBuilder

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type ParameterDefinitionBuilder

Returns

ParameterDefinitionBuilder: Instance wrapping the .net type ParameterDefinitionBuilder

Constructor

@staticmethod
def Constructor(streamTimeseriesProducer: c_void_p,
                location: str,
                definition: c_void_p = None) -> c_void_p

Parameters

streamTimeseriesProducer: c_void_p GC Handle Pointer to .Net type StreamTimeseriesProducer

location: str Underlying .Net type is string

definition: c_void_p (Optional) GC Handle Pointer to .Net type ParameterDefinition. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder

SetRange

def SetRange(minimumValue: float, maximumValue: float) -> c_void_p

Parameters

minimumValue: float Underlying .Net type is double

maximumValue: float Underlying .Net type is double

Returns

c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder

SetUnit

def SetUnit(unit: str) -> c_void_p

Parameters

unit: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder

SetFormat

def SetFormat(format: str) -> c_void_p

Parameters

format: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder

SetCustomProperties

def SetCustomProperties(customProperties: str) -> c_void_p

Parameters

customProperties: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder

AddDefinition

def AddDefinition(parameterId: str,
                  name: str = None,
                  description: str = None) -> c_void_p

Parameters

parameterId: str Underlying .Net type is string

name: str (Optional) Underlying .Net type is string. Defaults to None

description: str (Optional) Underlying .Net type is string. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.StreamEventsProducer

StreamEventsProducer Objects

class StreamEventsProducer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamEventsProducer

Returns

StreamEventsProducer: Instance wrapping the .net type StreamEventsProducer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamEventsProducer

Returns

StreamEventsProducer: Instance wrapping the .net type StreamEventsProducer

get_DefaultTags

def get_DefaultTags() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type Dictionary

set_DefaultTags

def set_DefaultTags(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type Dictionary

Returns

None: Underlying .Net type is void

get_DefaultLocation

def get_DefaultLocation() -> str

Parameters

Returns

str: Underlying .Net type is string

set_DefaultLocation

def set_DefaultLocation(value: str) -> None

Parameters

value: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

get_Epoch

def get_Epoch() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type DateTime

set_Epoch

def set_Epoch(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type DateTime

Returns

None: Underlying .Net type is void

AddTimestamp

def AddTimestamp(dateTime: c_void_p) -> c_void_p

Parameters

dateTime: c_void_p GC Handle Pointer to .Net type DateTime

Returns

c_void_p: GC Handle Pointer to .Net type EventDataBuilder

AddTimestamp2

def AddTimestamp2(timeSpan: c_void_p) -> c_void_p

Parameters

timeSpan: c_void_p GC Handle Pointer to .Net type TimeSpan

Returns

c_void_p: GC Handle Pointer to .Net type EventDataBuilder

AddTimestampMilliseconds

def AddTimestampMilliseconds(timeMilliseconds: int) -> c_void_p

Parameters

timeMilliseconds: int Underlying .Net type is long

Returns

c_void_p: GC Handle Pointer to .Net type EventDataBuilder

AddTimestampNanoseconds

def AddTimestampNanoseconds(timeNanoseconds: int) -> c_void_p

Parameters

timeNanoseconds: int Underlying .Net type is long

Returns

c_void_p: GC Handle Pointer to .Net type EventDataBuilder

AddDefinitions

def AddDefinitions(definitions: c_void_p) -> None

Parameters

definitions: c_void_p GC Handle Pointer to .Net type List

Returns

None: Underlying .Net type is void

AddDefinition

def AddDefinition(eventId: str,
                  name: str = None,
                  description: str = None) -> c_void_p

Parameters

eventId: str Underlying .Net type is string

name: str (Optional) Underlying .Net type is string. Defaults to None

description: str (Optional) Underlying .Net type is string. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder

AddLocation

def AddLocation(location: str) -> c_void_p

Parameters

location: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type EventDefinitionBuilder

Flush

def Flush() -> None

Parameters

Returns

None: Underlying .Net type is void

Publish

def Publish(data: c_void_p) -> None

Parameters

data: c_void_p GC Handle Pointer to .Net type EventData

Returns

None: Underlying .Net type is void

Publish2

def Publish2(events: c_void_p) -> None

Parameters

events: c_void_p GC Handle Pointer to .Net type ICollection

Returns

None: Underlying .Net type is void

Dispose

def Dispose() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.StreamPropertiesProducer

StreamPropertiesProducer Objects

class StreamPropertiesProducer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesProducer

Returns

StreamPropertiesProducer: Instance wrapping the .net type StreamPropertiesProducer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamPropertiesProducer

Returns

StreamPropertiesProducer: Instance wrapping the .net type StreamPropertiesProducer

get_FlushInterval

def get_FlushInterval() -> int

Parameters

Returns

int: Underlying .Net type is int

set_FlushInterval

def set_FlushInterval(value: int) -> None

Parameters

value: int Underlying .Net type is int

Returns

None: Underlying .Net type is void

get_Name

def get_Name() -> str

Parameters

Returns

str: Underlying .Net type is string

set_Name

def set_Name(value: str) -> None

Parameters

value: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

get_Location

def get_Location() -> str

Parameters

Returns

str: Underlying .Net type is string

set_Location

def set_Location(value: str) -> None

Parameters

value: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

get_TimeOfRecording

def get_TimeOfRecording() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type DateTime?

set_TimeOfRecording

def set_TimeOfRecording(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type DateTime?

Returns

None: Underlying .Net type is void

get_Metadata

def get_Metadata() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type ObservableDictionary

get_Parents

def get_Parents() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type ObservableCollection

AddParent

def AddParent(parentStreamId: str) -> None

Parameters

parentStreamId: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

RemoveParent

def RemoveParent(parentStreamId: str) -> None

Parameters

parentStreamId: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

Flush

def Flush() -> None

Parameters

Returns

None: Underlying .Net type is void

Dispose

def Dispose() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.StreamTimeseriesProducer

StreamTimeseriesProducer Objects

class StreamTimeseriesProducer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamTimeseriesProducer

Returns

StreamTimeseriesProducer: Instance wrapping the .net type StreamTimeseriesProducer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type StreamTimeseriesProducer

Returns

StreamTimeseriesProducer: Instance wrapping the .net type StreamTimeseriesProducer

get_Buffer

def get_Buffer() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesBufferProducer

Publish

def Publish(data: c_void_p) -> None

Parameters

data: c_void_p GC Handle Pointer to .Net type TimeseriesData

Returns

None: Underlying .Net type is void

Publish2

def Publish2(data: c_void_p) -> None

Parameters

data: c_void_p GC Handle Pointer to .Net type TimeseriesDataRaw

Returns

None: Underlying .Net type is void

get_DefaultLocation

def get_DefaultLocation() -> str

Parameters

Returns

str: Underlying .Net type is string

set_DefaultLocation

def set_DefaultLocation(value: str) -> None

Parameters

value: str Underlying .Net type is string

Returns

None: Underlying .Net type is void

AddDefinitions

def AddDefinitions(definitions: c_void_p) -> None

Parameters

definitions: c_void_p GC Handle Pointer to .Net type List

Returns

None: Underlying .Net type is void

AddDefinition

def AddDefinition(parameterId: str,
                  name: str = None,
                  description: str = None) -> c_void_p

Parameters

parameterId: str Underlying .Net type is string

name: str (Optional) Underlying .Net type is string. Defaults to None

description: str (Optional) Underlying .Net type is string. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder

AddLocation

def AddLocation(location: str) -> c_void_p

Parameters

location: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type ParameterDefinitionBuilder

Flush

def Flush() -> None

Parameters

Returns

None: Underlying .Net type is void

Dispose

def Dispose() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.TimeseriesBufferProducer

TimeseriesBufferProducer Objects

class TimeseriesBufferProducer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferProducer

Returns

TimeseriesBufferProducer: Instance wrapping the .net type TimeseriesBufferProducer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferProducer

Returns

TimeseriesBufferProducer: Instance wrapping the .net type TimeseriesBufferProducer

get_Epoch

def get_Epoch() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type DateTime

set_Epoch

def set_Epoch(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type DateTime

Returns

None: Underlying .Net type is void

AddTimestamp

def AddTimestamp(dateTime: c_void_p) -> c_void_p

Parameters

dateTime: c_void_p GC Handle Pointer to .Net type DateTime

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder

AddTimestamp2

def AddTimestamp2(timeSpan: c_void_p) -> c_void_p

Parameters

timeSpan: c_void_p GC Handle Pointer to .Net type TimeSpan

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder

AddTimestampMilliseconds

def AddTimestampMilliseconds(timeMilliseconds: int) -> c_void_p

Parameters

timeMilliseconds: int Underlying .Net type is long

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder

AddTimestampNanoseconds

def AddTimestampNanoseconds(timeNanoseconds: int) -> c_void_p

Parameters

timeNanoseconds: int Underlying .Net type is long

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder

Publish

def Publish(data: c_void_p) -> None

Parameters

data: c_void_p GC Handle Pointer to .Net type TimeseriesData

Returns

None: Underlying .Net type is void

get_DefaultTags

def get_DefaultTags() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type Dictionary

set_DefaultTags

def set_DefaultTags(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type Dictionary

Returns

None: Underlying .Net type is void

Flush

def Flush() -> None

Parameters

Returns

None: Underlying .Net type is void

Dispose

def Dispose() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.StreamProducer.TimeseriesDataBuilder

TimeseriesDataBuilder Objects

class TimeseriesDataBuilder(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataBuilder

Returns

TimeseriesDataBuilder: Instance wrapping the .net type TimeseriesDataBuilder

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataBuilder

Returns

TimeseriesDataBuilder: Instance wrapping the .net type TimeseriesDataBuilder

Constructor

@staticmethod
def Constructor(buffer: c_void_p, data: c_void_p,
                timestamp: c_void_p) -> c_void_p

Parameters

buffer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferProducer

data: c_void_p GC Handle Pointer to .Net type TimeseriesData

timestamp: c_void_p GC Handle Pointer to .Net type TimeseriesDataTimestamp

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder

AddValue

def AddValue(parameterId: str, value: float) -> c_void_p

Parameters

parameterId: str Underlying .Net type is string

value: float Underlying .Net type is double

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder

AddValue2

def AddValue2(parameterId: str, value: str) -> c_void_p

Parameters

parameterId: str Underlying .Net type is string

value: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder

AddValue3

def AddValue3(parameterId: str, value: c_void_p) -> c_void_p

Parameters

parameterId: str Underlying .Net type is string

value: c_void_p GC Handle Pointer to .Net type byte[]

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder

AddTag

def AddTag(tagId: str, value: str) -> c_void_p

Parameters

tagId: str Underlying .Net type is string

value: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder

AddTags

def AddTags(tags: c_void_p) -> c_void_p

Parameters

tags: c_void_p GC Handle Pointer to .Net type IEnumerable>

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataBuilder

Publish

def Publish() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesBuffer

TimeseriesBuffer Objects

class TimeseriesBuffer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBuffer

Returns

TimeseriesBuffer: Instance wrapping the .net type TimeseriesBuffer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBuffer

Returns

TimeseriesBuffer: Instance wrapping the .net type TimeseriesBuffer

add_OnDataReleased

def add_OnDataReleased(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnDataReleased

def remove_OnDataReleased(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnRawReleased

def add_OnRawReleased(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnRawReleased

def remove_OnRawReleased(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

get_PacketSize

def get_PacketSize() -> Optional[int]

Parameters

Returns

Optional[int]: Underlying .Net type is int?

set_PacketSize

def set_PacketSize(value: Optional[int]) -> None

Parameters

value: Optional[int] Underlying .Net type is int?

Returns

None: Underlying .Net type is void

get_BufferTimeout

def get_BufferTimeout() -> Optional[int]

Parameters

Returns

Optional[int]: Underlying .Net type is int?

set_BufferTimeout

def set_BufferTimeout(value: Optional[int]) -> None

Parameters

value: Optional[int] Underlying .Net type is int?

Returns

None: Underlying .Net type is void

get_TimeSpanInNanoseconds

def get_TimeSpanInNanoseconds() -> Optional[int]

Parameters

Returns

Optional[int]: Underlying .Net type is long?

set_TimeSpanInNanoseconds

def set_TimeSpanInNanoseconds(value: Optional[int]) -> None

Parameters

value: Optional[int] Underlying .Net type is long?

Returns

None: Underlying .Net type is void

get_TimeSpanInMilliseconds

def get_TimeSpanInMilliseconds() -> Optional[int]

Parameters

Returns

Optional[int]: Underlying .Net type is long?

set_TimeSpanInMilliseconds

def set_TimeSpanInMilliseconds(value: Optional[int]) -> None

Parameters

value: Optional[int] Underlying .Net type is long?

Returns

None: Underlying .Net type is void

get_Filter

def get_Filter() -> Callable[[c_void_p], bool]

Parameters

Returns

Callable[[c_void_p], bool]: Underlying .Net type is Func

set_Filter

def set_Filter(value: Callable[[c_void_p], bool]) -> None

Parameters

value: Callable[[c_void_p], bool] Underlying .Net type is Func

Returns

None: Underlying .Net type is void

get_CustomTriggerBeforeEnqueue

def get_CustomTriggerBeforeEnqueue() -> Callable[[c_void_p], bool]

Parameters

Returns

Callable[[c_void_p], bool]: Underlying .Net type is Func

set_CustomTriggerBeforeEnqueue

def set_CustomTriggerBeforeEnqueue(value: Callable[[c_void_p], bool]) -> None

Parameters

value: Callable[[c_void_p], bool] Underlying .Net type is Func

Returns

None: Underlying .Net type is void

get_CustomTrigger

def get_CustomTrigger() -> Callable[[c_void_p], bool]

Parameters

Returns

Callable[[c_void_p], bool]: Underlying .Net type is Func

set_CustomTrigger

def set_CustomTrigger(value: Callable[[c_void_p], bool]) -> None

Parameters

value: Callable[[c_void_p], bool] Underlying .Net type is Func

Returns

None: Underlying .Net type is void

Dispose

def Dispose() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesBufferConfiguration

TimeseriesBufferConfiguration Objects

class TimeseriesBufferConfiguration(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferConfiguration

Returns

TimeseriesBufferConfiguration: Instance wrapping the .net type TimeseriesBufferConfiguration

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesBufferConfiguration

Returns

TimeseriesBufferConfiguration: Instance wrapping the .net type TimeseriesBufferConfiguration

Constructor

@staticmethod
def Constructor() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesBufferConfiguration

get_PacketSize

def get_PacketSize() -> Optional[int]

Parameters

Returns

Optional[int]: Underlying .Net type is int?

set_PacketSize

def set_PacketSize(value: Optional[int]) -> None

Parameters

value: Optional[int] Underlying .Net type is int?

Returns

None: Underlying .Net type is void

get_TimeSpanInNanoseconds

def get_TimeSpanInNanoseconds() -> Optional[int]

Parameters

Returns

Optional[int]: Underlying .Net type is long?

set_TimeSpanInNanoseconds

def set_TimeSpanInNanoseconds(value: Optional[int]) -> None

Parameters

value: Optional[int] Underlying .Net type is long?

Returns

None: Underlying .Net type is void

get_TimeSpanInMilliseconds

def get_TimeSpanInMilliseconds() -> Optional[int]

Parameters

Returns

Optional[int]: Underlying .Net type is long?

set_TimeSpanInMilliseconds

def set_TimeSpanInMilliseconds(value: Optional[int]) -> None

Parameters

value: Optional[int] Underlying .Net type is long?

Returns

None: Underlying .Net type is void

get_CustomTriggerBeforeEnqueue

def get_CustomTriggerBeforeEnqueue() -> Callable[[c_void_p], bool]

Parameters

Returns

Callable[[c_void_p], bool]: Underlying .Net type is Func

set_CustomTriggerBeforeEnqueue

def set_CustomTriggerBeforeEnqueue(value: Callable[[c_void_p], bool]) -> None

Parameters

value: Callable[[c_void_p], bool] Underlying .Net type is Func

Returns

None: Underlying .Net type is void

get_CustomTrigger

def get_CustomTrigger() -> Callable[[c_void_p], bool]

Parameters

Returns

Callable[[c_void_p], bool]: Underlying .Net type is Func

set_CustomTrigger

def set_CustomTrigger(value: Callable[[c_void_p], bool]) -> None

Parameters

value: Callable[[c_void_p], bool] Underlying .Net type is Func

Returns

None: Underlying .Net type is void

get_Filter

def get_Filter() -> Callable[[c_void_p], bool]

Parameters

Returns

Callable[[c_void_p], bool]: Underlying .Net type is Func

set_Filter

def set_Filter(value: Callable[[c_void_p], bool]) -> None

Parameters

value: Callable[[c_void_p], bool] Underlying .Net type is Func

Returns

None: Underlying .Net type is void

get_BufferTimeout

def get_BufferTimeout() -> Optional[int]

Parameters

Returns

Optional[int]: Underlying .Net type is int?

set_BufferTimeout

def set_BufferTimeout(value: Optional[int]) -> None

Parameters

value: Optional[int] Underlying .Net type is int?

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesData

TimeseriesData Objects

class TimeseriesData(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesData

Returns

TimeseriesData: Instance wrapping the .net type TimeseriesData

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesData

Returns

TimeseriesData: Instance wrapping the .net type TimeseriesData

Constructor

@staticmethod
def Constructor(capacity: int = None) -> c_void_p

Parameters

capacity: int (Optional) Underlying .Net type is int. Defaults to 10

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesData

Constructor2

@staticmethod
def Constructor2(rawData: c_void_p,
                 parametersFilter: c_void_p = None,
                 merge: bool = True,
                 clean: bool = True) -> c_void_p

Parameters

rawData: c_void_p GC Handle Pointer to .Net type TimeseriesDataRaw

parametersFilter: c_void_p (Optional) GC Handle Pointer to .Net type string[]. Defaults to None

merge: bool (Optional) Underlying .Net type is Boolean. Defaults to True

clean: bool (Optional) Underlying .Net type is Boolean. Defaults to True

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesData

Constructor3

@staticmethod
def Constructor3(timestamps: c_void_p,
                 merge: bool = True,
                 clean: bool = True) -> c_void_p

Parameters

timestamps: c_void_p GC Handle Pointer to .Net type List

merge: bool (Optional) Underlying .Net type is Boolean. Defaults to True

clean: bool (Optional) Underlying .Net type is Boolean. Defaults to True

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesData

Clone

def Clone(parametersFilter: c_void_p) -> c_void_p

Parameters

parametersFilter: c_void_p GC Handle Pointer to .Net type string[]

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesData

get_Timestamps

def get_Timestamps() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamps

AddTimestamp

def AddTimestamp(dateTime: c_void_p) -> c_void_p

Parameters

dateTime: c_void_p GC Handle Pointer to .Net type DateTime

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

AddTimestamp2

def AddTimestamp2(timeSpan: c_void_p) -> c_void_p

Parameters

timeSpan: c_void_p GC Handle Pointer to .Net type TimeSpan

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

AddTimestampMilliseconds

def AddTimestampMilliseconds(timeMilliseconds: int) -> c_void_p

Parameters

timeMilliseconds: int Underlying .Net type is long

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

AddTimestampNanoseconds

def AddTimestampNanoseconds(timeNanoseconds: int) -> c_void_p

Parameters

timeNanoseconds: int Underlying .Net type is long

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

Equals

def Equals(obj: c_void_p) -> bool

Parameters

obj: c_void_p GC Handle Pointer to .Net type Object

Returns

bool: Underlying .Net type is Boolean

GetHashCode

def GetHashCode() -> int

Parameters

Returns

int: Underlying .Net type is int

quixstreams.native.Python.QuixStreamsStreaming.Models.TimeseriesDataTimestamp

TimeseriesDataTimestamp Objects

class TimeseriesDataTimestamp(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataTimestamp

Returns

TimeseriesDataTimestamp: Instance wrapping the .net type TimeseriesDataTimestamp

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TimeseriesDataTimestamp

Returns

TimeseriesDataTimestamp: Instance wrapping the .net type TimeseriesDataTimestamp

get_Parameters

def get_Parameters() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestampValues

get_Tags

def get_Tags() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestampTags

get_TimestampNanoseconds

def get_TimestampNanoseconds() -> int

Parameters

Returns

int: Underlying .Net type is long

set_TimestampNanoseconds

def set_TimestampNanoseconds(value: int) -> None

Parameters

value: int Underlying .Net type is long

Returns

None: Underlying .Net type is void

get_TimestampMilliseconds

def get_TimestampMilliseconds() -> int

Parameters

Returns

int: Underlying .Net type is long

get_Timestamp

def get_Timestamp() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type DateTime

get_TimestampAsTimeSpan

def get_TimestampAsTimeSpan() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type TimeSpan

AddValue

def AddValue(parameterId: str, value: float) -> c_void_p

Parameters

parameterId: str Underlying .Net type is string

value: float Underlying .Net type is double

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

AddValue2

def AddValue2(parameterId: str, value: str) -> c_void_p

Parameters

parameterId: str Underlying .Net type is string

value: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

AddValue3

def AddValue3(parameterId: str, value: c_void_p) -> c_void_p

Parameters

parameterId: str Underlying .Net type is string

value: c_void_p GC Handle Pointer to .Net type byte[]

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

AddValue4

def AddValue4(parameterId: str, value: c_void_p) -> c_void_p

Parameters

parameterId: str Underlying .Net type is string

value: c_void_p GC Handle Pointer to .Net type ParameterValue

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

RemoveValue

def RemoveValue(parameterId: str) -> c_void_p

Parameters

parameterId: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

AddTag

def AddTag(tagId: str, tagValue: str) -> c_void_p

Parameters

tagId: str Underlying .Net type is string

tagValue: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

AddTags

def AddTags(tags: c_void_p) -> c_void_p

Parameters

tags: c_void_p GC Handle Pointer to .Net type IEnumerable>

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

RemoveTag

def RemoveTag(tagId: str) -> c_void_p

Parameters

tagId: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type TimeseriesDataTimestamp

Equals

def Equals(obj: c_void_p) -> bool

Parameters

obj: c_void_p GC Handle Pointer to .Net type Object

Returns

bool: Underlying .Net type is Boolean

GetHashCode

def GetHashCode() -> int

Parameters

Returns

int: Underlying .Net type is int

ToString

def ToString() -> str

Parameters

Returns

str: Underlying .Net type is string

quixstreams.native.Python.QuixStreamsStreaming.PackageReceivedEventArgs

PackageReceivedEventArgs Objects

class PackageReceivedEventArgs(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type PackageReceivedEventArgs

Returns

PackageReceivedEventArgs: Instance wrapping the .net type PackageReceivedEventArgs

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type PackageReceivedEventArgs

Returns

PackageReceivedEventArgs: Instance wrapping the .net type PackageReceivedEventArgs

Constructor

@staticmethod
def Constructor(topicConsumer: c_void_p, consumer: c_void_p,
                package: c_void_p) -> c_void_p

Parameters

topicConsumer: c_void_p GC Handle Pointer to .Net type ITopicConsumer

consumer: c_void_p GC Handle Pointer to .Net type IStreamConsumer

package: c_void_p GC Handle Pointer to .Net type StreamPackage

Returns

c_void_p: GC Handle Pointer to .Net type PackageReceivedEventArgs

get_TopicConsumer

def get_TopicConsumer() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type ITopicConsumer

get_Stream

def get_Stream() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type IStreamConsumer

get_Package

def get_Package() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type StreamPackage

quixstreams.native.Python.QuixStreamsStreaming.QuixStreamingClient

QuixStreamingClient Objects

class QuixStreamingClient(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type QuixStreamingClient

Returns

QuixStreamingClient: Instance wrapping the .net type QuixStreamingClient

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type QuixStreamingClient

Returns

QuixStreamingClient: Instance wrapping the .net type QuixStreamingClient

Constructor

@staticmethod
def Constructor(token: str = None,
                autoCreateTopics: bool = True,
                properties: c_void_p = None,
                debug: bool = False,
                httpClient: c_void_p = None) -> c_void_p

Parameters

token: str (Optional) Underlying .Net type is string. Defaults to None

autoCreateTopics: bool (Optional) Underlying .Net type is Boolean. Defaults to True

properties: c_void_p (Optional) GC Handle Pointer to .Net type IDictionary. Defaults to None

debug: bool (Optional) Underlying .Net type is Boolean. Defaults to False

httpClient: c_void_p (Optional) GC Handle Pointer to .Net type HttpClient. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type QuixStreamingClient

get_TokenValidationConfig

def get_TokenValidationConfig() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type QuixStreamingClient.TokenValidationConfiguration

set_TokenValidationConfig

def set_TokenValidationConfig(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type QuixStreamingClient.TokenValidationConfiguration

Returns

None: Underlying .Net type is void

GetTopicConsumer

def GetTopicConsumer(
        topicIdOrName: str,
        consumerGroup: str = None,
        options: c_void_p = None,
        autoOffset: AutoOffsetReset = AutoOffsetReset.Latest) -> c_void_p

Parameters

topicIdOrName: str Underlying .Net type is string

consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None

options: c_void_p (Optional) GC Handle Pointer to .Net type CommitOptions. Defaults to None

autoOffset: AutoOffsetReset (Optional) Underlying .Net type is AutoOffsetReset. Defaults to Latest

Returns

c_void_p: GC Handle Pointer to .Net type ITopicConsumer

GetRawTopicConsumer

def GetRawTopicConsumer(
        topicIdOrName: str,
        consumerGroup: str = None,
        autoOffset: Optional[AutoOffsetReset] = None) -> c_void_p

Parameters

topicIdOrName: str Underlying .Net type is string

consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None

autoOffset: Optional[AutoOffsetReset] (Optional) Underlying .Net type is AutoOffsetReset?. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type IRawTopicConsumer

GetRawTopicProducer

def GetRawTopicProducer(topicIdOrName: str) -> c_void_p

Parameters

topicIdOrName: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type IRawTopicProducer

GetTopicProducer

def GetTopicProducer(topicIdOrName: str) -> c_void_p

Parameters

topicIdOrName: str Underlying .Net type is string

Returns

c_void_p: GC Handle Pointer to .Net type ITopicProducer

get_ApiUrl

def get_ApiUrl() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type Uri

set_ApiUrl

def set_ApiUrl(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type Uri

Returns

None: Underlying .Net type is void

get_CachePeriod

def get_CachePeriod() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type TimeSpan

set_CachePeriod

def set_CachePeriod(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type TimeSpan

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.QuixStreamingClientExtensions

QuixStreamingClientExtensions Objects

class QuixStreamingClientExtensions(object)

GetTopicConsumer

@staticmethod
def GetTopicConsumer(
        client: c_void_p,
        topicId: str,
        consumerGroup: str = None,
        commitMode: CommitMode = CommitMode.Automatic,
        autoOffset: AutoOffsetReset = AutoOffsetReset.Latest) -> c_void_p

Parameters

client: c_void_p GC Handle Pointer to .Net type QuixStreamingClient

topicId: str Underlying .Net type is string

consumerGroup: str (Optional) Underlying .Net type is string. Defaults to None

commitMode: CommitMode (Optional) Underlying .Net type is CommitMode. Defaults to Automatic

autoOffset: AutoOffsetReset (Optional) Underlying .Net type is AutoOffsetReset. Defaults to Latest

Returns

c_void_p: GC Handle Pointer to .Net type ITopicConsumer

quixstreams.native.Python.QuixStreamsStreaming.QuixStreamingClient_TokenValidationConfiguration

TokenValidationConfiguration Objects

class TokenValidationConfiguration(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TokenValidationConfiguration

Returns

TokenValidationConfiguration: Instance wrapping the .net type TokenValidationConfiguration

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type TokenValidationConfiguration

Returns

TokenValidationConfiguration: Instance wrapping the .net type TokenValidationConfiguration

Constructor

@staticmethod
def Constructor() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type QuixStreamingClient.TokenValidationConfiguration

get_Enabled

def get_Enabled() -> bool

Parameters

Returns

bool: Underlying .Net type is Boolean

set_Enabled

def set_Enabled(value: bool) -> None

Parameters

value: bool Underlying .Net type is Boolean

Returns

None: Underlying .Net type is void

get_WarningBeforeExpiry

def get_WarningBeforeExpiry() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type TimeSpan?

set_WarningBeforeExpiry

def set_WarningBeforeExpiry(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type TimeSpan?

Returns

None: Underlying .Net type is void

get_WarnAboutNonPatToken

def get_WarnAboutNonPatToken() -> bool

Parameters

Returns

bool: Underlying .Net type is Boolean

set_WarnAboutNonPatToken

def set_WarnAboutNonPatToken(value: bool) -> None

Parameters

value: bool Underlying .Net type is Boolean

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Raw.IRawTopicConsumer

IRawTopicConsumer Objects

class IRawTopicConsumer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type IRawTopicConsumer

Returns

IRawTopicConsumer: Instance wrapping the .net type IRawTopicConsumer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type IRawTopicConsumer

Returns

IRawTopicConsumer: Instance wrapping the .net type IRawTopicConsumer

Subscribe

def Subscribe() -> None

Parameters

Returns

None: Underlying .Net type is void

add_OnMessageReceived

def add_OnMessageReceived(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnMessageReceived

def remove_OnMessageReceived(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnErrorOccurred

def add_OnErrorOccurred(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnErrorOccurred

def remove_OnErrorOccurred(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnDisposed

def add_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnDisposed

def remove_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Raw.IRawTopicProducer

IRawTopicProducer Objects

class IRawTopicProducer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type IRawTopicProducer

Returns

IRawTopicProducer: Instance wrapping the .net type IRawTopicProducer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type IRawTopicProducer

Returns

IRawTopicProducer: Instance wrapping the .net type IRawTopicProducer

Publish

def Publish(data: c_void_p) -> None

Parameters

data: c_void_p GC Handle Pointer to .Net type RawMessage

Returns

None: Underlying .Net type is void

add_OnDisposed

def add_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnDisposed

def remove_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Raw.RawMessage

RawMessage Objects

class RawMessage(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type RawMessage

Returns

RawMessage: Instance wrapping the .net type RawMessage

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type RawMessage

Returns

RawMessage: Instance wrapping the .net type RawMessage

Constructor

@staticmethod
def Constructor(key: c_void_p, value: c_void_p) -> c_void_p

Parameters

key: c_void_p GC Handle Pointer to .Net type byte[]

value: c_void_p GC Handle Pointer to .Net type byte[]

Returns

c_void_p: GC Handle Pointer to .Net type RawMessage

Constructor2

@staticmethod
def Constructor2(value: c_void_p) -> c_void_p

Parameters

value: c_void_p GC Handle Pointer to .Net type byte[]

Returns

c_void_p: GC Handle Pointer to .Net type RawMessage

get_Metadata

def get_Metadata() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type ReadOnlyDictionary

get_Key

def get_Key() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type byte[]

set_Key

def set_Key(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type byte[]

Returns

None: Underlying .Net type is void

get_Value

def get_Value() -> c_void_p

Parameters

Returns

c_void_p: GC Handle Pointer to .Net type byte[]

set_Value

def set_Value(value: c_void_p) -> None

Parameters

value: c_void_p GC Handle Pointer to .Net type byte[]

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Raw.RawTopicConsumer

RawTopicConsumer Objects

class RawTopicConsumer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type RawTopicConsumer

Returns

RawTopicConsumer: Instance wrapping the .net type RawTopicConsumer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type RawTopicConsumer

Returns

RawTopicConsumer: Instance wrapping the .net type RawTopicConsumer

Constructor

@staticmethod
def Constructor(brokerAddress: str,
                topicName: str,
                consumerGroup: str,
                brokerProperties: c_void_p = None,
                autoOffset: Optional[AutoOffsetReset] = None) -> c_void_p

Parameters

brokerAddress: str Underlying .Net type is string

topicName: str Underlying .Net type is string

consumerGroup: str Underlying .Net type is string

brokerProperties: c_void_p (Optional) GC Handle Pointer to .Net type Dictionary. Defaults to None

autoOffset: Optional[AutoOffsetReset] (Optional) Underlying .Net type is AutoOffsetReset?. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type RawTopicConsumer

add_OnMessageReceived

def add_OnMessageReceived(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnMessageReceived

def remove_OnMessageReceived(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnDisposed

def add_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnDisposed

def remove_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

add_OnErrorOccurred

def add_OnErrorOccurred(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnErrorOccurred

def remove_OnErrorOccurred(
        value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

Subscribe

def Subscribe() -> None

Parameters

Returns

None: Underlying .Net type is void

Dispose

def Dispose() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.Raw.RawTopicProducer

RawTopicProducer Objects

class RawTopicProducer(object)

__new__

def __new__(cls, net_pointer: c_void_p)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type RawTopicProducer

Returns

RawTopicProducer: Instance wrapping the .net type RawTopicProducer

__init__

def __init__(net_pointer: c_void_p, finalize: bool = True)

Parameters

net_pointer: c_void_p GC Handle Pointer to .Net type RawTopicProducer

Returns

RawTopicProducer: Instance wrapping the .net type RawTopicProducer

Constructor

@staticmethod
def Constructor(brokerAddress: str,
                topicName: str,
                brokerProperties: c_void_p = None) -> c_void_p

Parameters

brokerAddress: str Underlying .Net type is string

topicName: str Underlying .Net type is string

brokerProperties: c_void_p (Optional) GC Handle Pointer to .Net type Dictionary. Defaults to None

Returns

c_void_p: GC Handle Pointer to .Net type RawTopicProducer

add_OnDisposed

def add_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

remove_OnDisposed

def remove_OnDisposed(value: Callable[[c_void_p, c_void_p], None]) -> None

Parameters

value: Callable[[c_void_p, c_void_p], None] Underlying .Net type is EventHandler

Returns

None: Underlying .Net type is void

Publish

def Publish(message: c_void_p) -> None

Parameters

message: c_void_p GC Handle Pointer to .Net type RawMessage

Returns

None: Underlying .Net type is void

Dispose

def Dispose() -> None

Parameters

Returns

None: Underlying .Net type is void

quixstreams.native.Python.QuixStreamsStreaming.StreamClosedEventArgs

StreamClosedEventArgs Objects

class StreamClosedEventArgs(object)

__new__

def __new__(cls, net_pointer: c_void_p)