io.openmessaging.api.SendCallback Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmessaging-api Show documentation

There is a newer version: 2.2.1-pubsub

/*
 * 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.openmessaging.api;

/**
 * Call back interface used in {@link Producer#sendAsync(Message, SendCallback)}.
 *
 * @version OMS 1.2.0
 * @since OMS 1.2.0
 */
public interface SendCallback {

    /**
     * When message send success, this method will be invoked.
     *
     * @param sendResult send message result.
     * @see SendResult
     */
    void onSuccess(final SendResult sendResult);

    /**
     * When message send failed, this method will be invoked.
     *
     * @param context send message exception context.
     * @see OnExceptionContext
     */
    void onException(final OnExceptionContext context);
}