com.microsoft.azure.servicebus.IMessageHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of azure-servicebus Show documentation

Java library for Azure Service Bus

The newest version!

// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.microsoft.azure.servicebus;

import java.util.concurrent.CompletableFuture;

/**
 * Defines the contract for registering the callback {@link QueueClient#registerMessageHandler(IMessageHandler)} and {@link SubscriptionClient#registerMessageHandler(IMessageHandler)} for {@link QueueClient} and {@link SubscriptionClient}.
 */
public interface IMessageHandler {

    /**
     * The callback for message pump to pass received {@link Message}s.
     *
     * @param message The received {@link Message}.
     * @return CompletableFuture for the message handler.
     */
    CompletableFuture onMessageAsync(IMessage message);

    /**
     * Receiving the exceptions that passed by pump during message processing.
     *
     * @param exception Exception received in pump.
     * @param phase     Exception phase.
     */
    void notifyException(Throwable exception, ExceptionPhase phase);
}