/*
 *  Wave, containers provisioning service
 *  Copyright (c) 2023-2024, Seqera Labs
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

package io.seqera.wave.service.data.stream
/**
 * Define the contract for a generic message stream
 * able to add message and consume them asynchronously.
 *
 * @author Paolo Di Tommaso <paolo.ditommaso@gmail.com>
 */
interface MessageStream<M> {

    /**
     * Initialize the stream with the given Id
     *
     * @param streamId The uniqur ID of the stream to be initialized
     */
    void init(String streamId)

    /**
     * Offer a message to the stream.
     *
     * @param message
     *      The message that should be offered to the queue
     */
    void offer(String streamId, M message)

    /**
     * Consume a message from the stream and invoke the specified consumer predicate
     *
     * @param streamId
     *      The target stream ID
     * @param consumer
     *      The {@link MessageConsumer} instance to be invoked to consume the message
     * @return
     *      {code true} when the message has been processed successfully,
     *      otherwise {@code false} when the message needs to be further processed
     */
    boolean consume(String streamId, MessageConsumer<M> consumer)

}
