/*
 * Copyright 2017, TeamDev Ltd. All rights reserved.
 *
 * Redistribution and use in source and/or binary forms, with or without
 * modification, must retain the above copyright notice and the following
 * disclaimer.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package io.spine.server.bus;

import io.spine.annotation.Internal;
import io.spine.base.Error;
import io.spine.core.MessageEnvelope;

/**
 * An interface defining a function which handles a dead message.
 *
 * <p>If a message with no target dispatchers found is passed to the bus, it will result in a call
 * to this function. The function handles such message and produces an {@link Error} as a response.
 *
 * @author Dmytro Dashenkov
 */
@Internal
public interface DeadMessageHandler<E extends MessageEnvelope<?>> {

    /**
     * Handles the dead message in a bus-specific way and produces an {@link Error} for notifying
     * the poster about the absence of dispatchers.
     *
     * @param message the dead message
     * @return the {@link Error} describing the dead message
     */
    MessageUnhandled handleDeadMessage(E message);
}

/*
 * Copyright 2017, TeamDev Ltd. All rights reserved.
 *
 * Redistribution and use in source and/or binary forms, with or without
 * modification, must retain the above copyright notice and the following
 * disclaimer.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package io.spine.server.bus;

import io.spine.annotation.Internal;
import io.spine.base.Error;
import io.spine.core.MessageEnvelope;

/**
 * An interface defining a function which handles a dead message.
 *
 * <p>If a message with no target dispatchers found is passed to the bus, it will result in a call
 * to this function. The function handles such message and produces {@link MessageUnhandled}
 * instance describing the dead message.
 *
 * @author Dmytro Dashenkov
 */
@Internal
public interface DeadMessageHandler<E extends MessageEnvelope<?>> {

    /**
     * Handles the dead message in a bus-specific way and produces an {@link Error} for notifying
     * the poster about the absence of dispatchers.
     *
     * @param message the dead message
     * @return the {@link MessageUnhandled} instance describing the dead message
     */
    MessageUnhandled handleDeadMessage(E message);
}

Adjust Javadoc.