Table of Contents

Module SYSKFK

Description

Properties

Property YES/NO
Single page frame No
Show toolbar No
Show menu No
Show statusbar No
Show hint No
Fit panel size No

Rules

Rule Name Additional
function TDKFKInitConsumer numeric method
function TDKFKInitProducer numeric method
sub KafkaCloseLibrary method
sub TDKFKApplyConfig method
sub TDKFKAssertConfig method
sub TDKFKCleanup method
sub TDKFKCommit method
sub TDKFKConfigGet method
sub TDKFKConfigSet method
sub TDKFKConsume method
sub TDKFKConsumeFile method
sub TDKFKCreateConsumer method
sub TDKFKCreateProducer method
sub TDKFKProduce method
sub TDKFKProduceFile method
sub TDKFKSubscribe method

Rules Description and Comments

function TDKFKInitConsumer : numeric method

allocate and initialize connection handle

Corresponding functions: TDKFKInitProducer, TDKFKCleanup

function TDKFKInitProducer : numeric method

allocate and initialize connection handle

Corresponding functions: TDKFKInitConsumer, TDKFKCleanup

sub KafkaCloseLibrary method

close library

sub TDKFKApplyConfig( in ArgContext text, in ArgRole text, in ArgHandle numeric, out ArgTimeout numeric ) method

set porperty for handle

ArgContext Context used for inifile name and cache key
ArgRole Role name to support producer/consumer specific configuration
ArgHandle Connection handle from TDKFKInitProducer/TDKFKInitConsumer
ArgConfigKeys Config keys
ArgConfigValues Config values, matched to config keys by index

Corresponding functions: -

sub TDKFKAssertConfig( in ArgContext text, in ArgRole text, out ArgConfigKeys stream, out ArgConfigValues stream, out ArgTimeout numeric ) method

get/assert Kafka configuration

ArgContext Context used for inifile name and cache key
ArgRole Role name to support producer/consumer specific configuration
ArgConfigKeys Config keys
ArgConfigValues Config values, matched to config keys by index
ArgTineout Timeout

Corresponding functions: -

sub TDKFKCleanup( inout ArgHandle numeric ) method

cleanup and free connection handle

ArgHandle Connection handle from TDKFKInitProducer/TDKFKInitConsumer

Corresponding functions: TDKFKInitProducer, TDKFKInitConsumer

sub TDKFKCommit( in ArgHandle numeric ) method

Commit message previously read MQ

ArgHandle Connection handle from TDKFKInitProducer/TDKFKInitConsumer

Note: Does nothing if 'enable.auto.commit' is 'true'

Corresponding functions: TDKFKConsumer

sub TDKFKConfigGet( in ArgHandle numeric, in ArgName text, out ArgValue text ) method

get porperty for handle

ArgHandle Connection handle from TDKFKInitProducer/TDKFKInitConsumer
ArgName Name of Configuration Property
ArgValue Value of Configuration Property

Corresponding functions: TDKFKConfigSet

sub TDKFKConfigSet( in ArgHandle numeric, in ArgName text, in ArgValue text ) method

set porperty for handle

ArgHandle Connection handle from TDKFKInitProducer/TDKFKInitConsumer
ArgName Name of Configuration Property
ArgValue Value of Configuration Property

Corresponding functions: TDKFKConfigGet

sub TDKFKConsume( in ArgHandle numeric, out ArgHeaderKeys stream, out ArgHeaderValues stream, out ArgKey text, out ArgValue text, in ArgTimeout numeric ) method

cleanup and free connection handle

ArgHandle Connection handle from TDKFKInitProducer
ArgHeaderKeys List of header key names received
ArgHeaderValue List of corresponding values received
ArgMessage Message received
ArgTimeout Timeout

Corresponding functions: TDKFKSubscribe, TDKafkaConsumeFile, TDKFKProduce, TDKafkaProduceFile

sub TDKFKConsumeFile( in ArgHandle numeric, out ArgHeaderKeys stream, out ArgHeaderValues stream, out ArgKey text, in ArgFilename text, in ArgTimeout numeric ) method

cleanup and free connection handle

ArgHandle Connection handle from TDKFKInitProducer
ArgHeaderKeys List of header key names received
ArgHeaderValue List of corresponding values received
ArgFilename File for writing content received
ArgTimeout Timeout

Corresponding functions: TDKFKSubscribe, TDKafkaConsume, TDKFKProduce, TDKafkaProduceFile

sub TDKFKCreateConsumer( in ArgHandle numeric ) method

cleanup and free connection handle

ArgHandle Connection handle from TDKFKInitConsumer

Corresponding functions: TDKFKCreateConsumer

sub TDKFKCreateProducer( in ArgHandle numeric ) method

cleanup and free connection handle

ArgHandle Connection handle from TDKFKInitProducer

Corresponding functions: TDKFKCreateConsumer

sub TDKFKProduce( in ArgHandle numeric, in ArgTopic text, in ArgHeaderKeys stream, in ArgHeaderValues stream, in ArgKey text, in ArgValue text, in ArgTimeout numeric ) method

cleanup and free connection handle

ArgHandle Connection handle from TDKFKInitProducer
ArgTopic Topic to produce to
ArgHeaderKeys List of header key names
ArgHeaderValue List of corresponding values
ArgMessage Message to send
ArgTimeout Timeout

Corresponding functions: TDKFKProduceFile, TDKFKConsume, TDKFKConsumeFile

sub TDKFKProduceFile( in ArgHandle numeric, in ArgTopic text, in ArgHeaderKeys stream, in ArgHeaderValues stream, in ArgKey text, in ArgFilename text, in ArgTimeout numeric ) method

cleanup and free connection handle

ArgHandle Connection handle from TDKFKInitProducer
ArgTopic Topic to produce to
ArgHeaderKeys List of header key names
ArgHeaderValue List of corresponding values
ArgFilename File conatining content to send
ArgTimeout Timeout

Corresponding functions: TDKFKProduce, TDKFKConsume, TDKFKConsumeFile

sub TDKFKSubscribe( in ArgHandle numeric, in ArgTopics stream ) method

cleanup and free connection handle

ArgHandle Connection handle from TDKFKInitProducer
ArgTopics Topics to consume from

Corresponding functions: TDKFKConsume, TDKafkaConsumeFile

Modules

Module class Instance Comment
ENCMOD ENCMOD