org.eclipse.hono.application.client.kafka.KafkaApplicationClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hono-client-application-kafka Show documentation

Clients for Hono's northbound Kafka-based APIs for implementing business applications

There is a newer version: 2.6.0

Show newest version

/*
 * Copyright (c) 2021, 2022 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */

package org.eclipse.hono.application.client.kafka;

import org.eclipse.hono.application.client.ApplicationClient;
import org.eclipse.hono.application.client.DownstreamMessage;
import org.eclipse.hono.application.client.MessageConsumer;

import io.vertx.core.Future;
import io.vertx.core.Handler;

/**
 * A Kafka based client that supports Hono's north bound operations to send commands and receive telemetry,
 * event and command response messages.
 */
public interface KafkaApplicationClient extends ApplicationClient {

    /**
     * Creates a client for consuming data from Hono's north bound Telemetry API.
     *
     * @param tenantId The tenant to consume data for.
     * @param messageHandler The handler to be invoked for each message created from a record.
     * @param closeHandler The handler invoked when the consumer is closed due to an error.
     * @return A future that will complete with the consumer once it is ready. The future will fail if the consumer
     *         cannot be started.
     * @throws NullPointerException if any of tenant ID or message handler are {@code null}.
     */
    @Override
    Future createTelemetryConsumer(
            String tenantId,
            Handler> messageHandler,
            Handler closeHandler);

    /**
     * Creates a client for consuming data from Hono's north bound Event API.
     *
     * @param tenantId The tenant to consume data for.
     * @param messageHandler The handler to be invoked for each message created from a record.
     * @param closeHandler The handler invoked when the consumer is closed due to an error.
     * @return A future that will complete with the consumer once it is ready. The future will fail if the consumer
     *         cannot be started.
     * @throws NullPointerException if any of tenant ID or message handler are {@code null}.
     */
    @Override
    Future createEventConsumer(
            String tenantId,
            Handler> messageHandler,
            Handler closeHandler);
}