io.xream.x7.reliable.api.ReliableBackend Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of x7-reyc Show documentation
http://x7.xream.io
There is a newer version: 2.13.0.RELEASE
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.xream.x7.reliable.api;

import java.util.concurrent.Callable;

/**
 * @author Sim [email protected]
 * @apiNote to use @EnableReliabilityManagement, @ReliableProducer and @ReliableOnConsumed, 

 *     has to implements ReliableBackend, develop and deploy 'Reliable Message Center'
 */
public interface ReliableBackend {

    /**
     * @param useTcc
     * as regards to TCC, TCC implemented to check all resources, 

     *     at first, produce 'TOPIC'_TCC_TRY 

     *     if all resouces ok, produce 'TOPIC'_TCC_CONFIRM 

     *     any exception occured, produce 'TOPIC'_TCC_CANCEL 

     *     anyway, when isTcc = true, has to prepare 3 listeners 

     * @param id framework generate id
     * @param retryMax message retryMax
     * @param underConstruction message underConstruction
     * @param topic message topic
     * @param body  message body
     * @param messageTraceable getMsgId(), set tracingId
     * @param svcs  the nameList of other listening domain service
     * @param callable  the service or controller handle the bisiness
     */
    Object produceReliably(Boolean useTcc, String id, int retryMax, boolean underConstruction, String topic, Object body, MessageTraceable messageTraceable, String[] svcs, Callable callable);

    /**
     *
     * @param svc  the name of listening domain service
     * @param message message body
     * @param runnable  listener handle the bisiness
     */
    void onConsumed(String svc, Object message, Runnable runnable);
    boolean createNext(String id, int retryMax, String topic, Object body, Object preMessage, String[] svcs);
    /**
     * TCC
     * @param msgId
     */
    boolean tryToConfirm(String msgId);

    /**
     * TCC
     * @param msgId
     */
    boolean cancel(String msgId);

}