Namespace: OpenEdge.Messaging.Kafka
Class
KafkaConsumer
Parent classes:
Progress.Lang.Object
OpenEdge.Messaging.Kafka.KafkaConsumer

Inherits: Progress.Lang.Object
Implements: OpenEdge.Messaging.IConsumer

/*
Copyright © 2021 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.




Method Summary
Options Name Purpose
CommitOffset (IConsumerRecord) /** Acknowledge the receipt of the message and request the broker commit the offset of the message to store record position for recovery. */
CopyTopicDeserializers ()
CHARACTER GetConfigOption (character)
CHARACTER GetConsumerOption (character) /** Retrieve the value of an option. */
OpenEdge.Messaging.IDeserializer GetKeyDeserializer (character)
CHARACTER GetTopicConfigOption (character, character) /** Lookup a configuration option for a topic. */
OpenEdge.Messaging.IDeserializer GetValueDeserializer (character)
OpenEdge.Messaging.IDeserializer lookupKeyDeSerializerForTopic (String) /* lookup the deserializer for the topic. if not already cached, create a new one from what is set in the topic config props, or fall back to using the default deserializer configured for this consumer. */
Progress.Lang.Object LookupTopicConfigValue (String, character) /** Lookup a configuration value from the named topic. */
OpenEdge.Messaging.IDeserializer lookupValueDeserializerForTopic (String) /* Lookup value deserializer for the given topic. This may return a cached value. If the topic doesn't have a deserializer specified, this falls back to using the consumer's value deserializer. */
OpenEdge.Messaging.IConsumerRecord Poll (integer) /** Poll for a single record @param timeout Timeout in milliseconds, to request the broker wait for records to send. @return A consumer record from one of the subscribed topics, if one is available. */

Constructor Summary
Options Name Purpose
KafkaConsumer (IConsumerDelegate, IStringStringMap, IStringKeyedMap) /** Create a Kafka consumer. This is marked as package-protected because we only want to create these through the ConsumerBuilder that is specific to Kafka. */

Property Summary
Options Name Purpose
CHARACTER ImplementationName
CHARACTER ImplementationVersion
OpenEdge.Messaging.IDeserializer KeyDeserializer
OpenEdge.Messaging.IDeserializer ValueDeserializer


Method Detail
Top

CommitOffset (IConsumerRecord)
Purpose:
Acknowledge the receipt of the message and request the broker commit the offset of the message
to store record position for recovery.
Parameters:
consumerRecord OpenEdge.Messaging.IConsumerRecord
Top

CopyTopicDeserializers ()
Top

CHARACTER GetConfigOption (character)
Parameters:
name CHARACTER
Returns CHARACTER
Top

CHARACTER GetConsumerOption (character)
Purpose:
Retrieve the value of an option.
Parameters:
name CHARACTER
Returns CHARACTER
Top

OpenEdge.Messaging.IDeserializer GetKeyDeserializer (character)
Parameters:
topicName CHARACTER
Returns OpenEdge.Messaging.IDeserializer
Top

CHARACTER GetTopicConfigOption (character, character)
Purpose:
Lookup a configuration option for a topic.
Parameters:
topicName CHARACTER
name CHARACTER
Returns CHARACTER
Top

OpenEdge.Messaging.IDeserializer GetValueDeserializer (character)
Parameters:
topicName CHARACTER
Returns OpenEdge.Messaging.IDeserializer
Top

OpenEdge.Messaging.IDeserializer lookupKeyDeSerializerForTopic (String)
/*
lookup the deserializer for the topic. if not already cached, create a new one
from what is set in the topic config props, or fall back to using the default
deserializer configured for this consumer.
Parameters:
destString OpenEdge.Core.String
Returns OpenEdge.Messaging.IDeserializer
Top

Progress.Lang.Object LookupTopicConfigValue (String, character)
Purpose:
Lookup a configuration value from the named topic.
Parameters:
topicName OpenEdge.Core.String
propertyName CHARACTER
Returns Progress.Lang.Object
Top

OpenEdge.Messaging.IDeserializer lookupValueDeserializerForTopic (String)
/*
Lookup value deserializer for the given topic. This may return a cached value.
If the topic doesn't have a deserializer specified, this falls back to using
the consumer's value deserializer.
Parameters:
destString OpenEdge.Core.String
Returns OpenEdge.Messaging.IDeserializer
Top

OpenEdge.Messaging.IConsumerRecord Poll (integer)
Purpose:
Poll for a single record
Parameters:
timeout INTEGER
Timeout in milliseconds, to request the broker wait for records to send.
Returns OpenEdge.Messaging.IConsumerRecord
A consumer record from one of the subscribed topics, if one is available.


Constructor Detail
Top

KafkaConsumer (IConsumerDelegate, IStringStringMap, IStringKeyedMap)
Purpose:
Create a Kafka consumer.
This is marked as package-protected because we only want
to create these through the ConsumerBuilder that is specific to Kafka.
Parameters:
bioConsumer OpenEdge.Messaging.Internal.IConsumerDelegate
config OpenEdge.Core.Collections.IStringStringMap
topicConfigurations OpenEdge.Core.Collections.IStringKeyedMap


Property Detail
Top

CHARACTER ImplementationName
Returns CHARACTER
Top

CHARACTER ImplementationVersion
Returns CHARACTER
Top

OpenEdge.Messaging.IDeserializer KeyDeserializer
Returns OpenEdge.Messaging.IDeserializer
Top

OpenEdge.Messaging.IDeserializer ValueDeserializer
Returns OpenEdge.Messaging.IDeserializer


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.5.0