Namespace: OpenEdge.Messaging
Interface
IConsumer
Parent classes:
Inherits: Progress.Lang.Object

/*
Copyright © 2021 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
Purpose:
Return the name of the underlying implementation.




Method Summary
Options Name Purpose
CommitOffset (IConsumerRecord) /** Commit the offset information for a record. This notifies the broker that the application has completed processing the record. The broker will store the offset associated with the consumer group the client is part of. By storing the offset with the broker, the client can recover processing at the next record within the topic if the client needs to be restarted. */
OpenEdge.Messaging.IConsumerRecord Poll (integer) /** Request a message from the server to process. The timeout indicates how much time, in milliseconds, the broker should spend before returning a response to the client. If there are no records available within the given time period, this will return the UNKNOWN value. */

Property Summary
Options Name Purpose
CHARACTER ImplementationName
CHARACTER ImplementationVersion


Method Detail
Top

CommitOffset (IConsumerRecord)

Purpose:
Commit the offset information for a record. This notifies the broker that
the application has completed processing the record. The broker will store the offset
associated with the consumer group the client is part of. By storing the offset with the broker,
the client can recover processing at the next record within the topic if the client needs to be restarted.
Parameters:
consumerRecord OpenEdge.Messaging.IConsumerRecord
Top

OpenEdge.Messaging.IConsumerRecord Poll (integer)

Purpose:
Request a message from the server to process. The timeout indicates how
much time, in milliseconds, the broker should spend before returning
a response to the client. If there are no records available within the
given time period, this will return the UNKNOWN value.
Parameters:
timeout INTEGER
Returns OpenEdge.Messaging.IConsumerRecord


Property Detail
Top

CHARACTER ImplementationName

Returns CHARACTER
Top

CHARACTER ImplementationVersion

Returns CHARACTER


Copyright © 2022 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.6.0