dubbo AsyncContext 源码

dubbo AsyncContext 代码

文件路径：/dubbo-rpc/dubbo-rpc-api/src/main/java/org/apache/dubbo/rpc/AsyncContext.java

/*
 * 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 org.apache.dubbo.rpc;

/**
 * AsyncContext works like {@see javax.servlet.AsyncContext} in the Servlet 3.0.
 * An AsyncContext is stated by a call to {@link RpcContext#startAsync()}.
 * <p>
 * The demo is {@see com.alibaba.dubbo.examples.async.AsyncConsumer}
 * and {@see com.alibaba.dubbo.examples.async.AsyncProvider}
 */
public interface AsyncContext {

    /**
     * write value and complete the async context.
     *
     * @param value invoke result
     */
    void write(Object value);

    /**
     * @return true if the async context is started
     */
    boolean isAsyncStarted();

    /**
     * change the context state to stop
     */
    boolean stop();

    /**
     * change the context state to start
     */
    void start();

    /**
     * Signal RpcContext switch.
     * Use this method to switch RpcContext from a Dubbo thread to a new thread created by the user.
     *
     * Note that you should use it in a new thread like this:
     * <code>
     * public class AsyncServiceImpl implements AsyncService {
     *     public String sayHello(String name) {
     *         final AsyncContext asyncContext = RpcContext.startAsync();
     *         new Thread(() -> {
     *
     *             // right place to use this method
     *             asyncContext.signalContextSwitch();
     *
     *             try {
     *                 Thread.sleep(500);
     *             } catch (InterruptedException e) {
     *                 e.printStackTrace();
     *             }
     *             asyncContext.write("Hello " + name + ", response from provider.");
     *         }).start();
     *         return null;
     *     }
     * }
     * </code>
     */
    void signalContextSwitch();

    /**
     * Reset Context is not necessary. Only reset context after result was write back if it is necessary.
     *
     * <code>
     * public class AsyncServiceImpl implements AsyncService {
     * public String sayHello(String name) {
     * final AsyncContext asyncContext = RpcContext.startAsync();
     * new Thread(() -> {
     * <p>
     * // the right place to use this method
     * asyncContext.signalContextSwitch();
     * <p>
     * try {
     * Thread.sleep(500);
     * } catch (InterruptedException e) {
     * e.printStackTrace();
     * }
     * asyncContext.write("Hello " + name + ", response from provider.");
     * // only reset after asyncContext.write()
     * asyncContext.resetContext();
     * }).start();
     * return null;
     * }
     * }
     * </code>
     *
     * <code>
     * public class AsyncServiceImpl implements AsyncService {
     * public CompletableFuture sayHello(String name) {
     * CompletableFuture future = new CompletableFuture();
     * final AsyncContext asyncContext = RpcContext.startAsync();
     * new Thread(() -> {
     * // the right place to use this method
     * asyncContext.signalContextSwitch();
     * // some operations...
     * future.complete();
     * // only reset after future.complete()
     * asyncContext.resetContext();
     * }).start();
     * return future;
     * }
     * }
     * </code>
     */
    void resetContext();
}

相关信息

dubbo 源码目录

相关文章

dubbo AppResponse 源码

dubbo AsyncContextImpl 源码

dubbo AsyncRpcResult 源码

dubbo AttachmentsAdapter 源码

dubbo BaseFilter 源码

dubbo CancellationContext 源码

dubbo CancellationListener 源码

dubbo Constants 源码

dubbo ExecutableListener 源码

dubbo Exporter 源码