ICE的异步方法调用 c++

http://www.cppprog.com/2009/0612/125.html

 第17章《异步程序设计》

网上摘录比较清晰的解释：

“AMI是客户端的功能，I ＝ Invoke，客户端调用完后马上返回，保证客户端不阻塞。 AMD是服务器端功能，D＝ Dispatch， 服务器端相应客户调用过程中，使用AMD可以在处理还没有完成时就提前返回结果，就像在函数中间加个return语句一样，不同的是这个return下面 的语句会接着执行。 还有一点很有特色的是，AMI和AMD是完全互相独立的，也就是说对于同一个interface，客户端不会知道服务器是否用AMD方式相应请求，服务器 端也不会知道客户端是否用AMI发起调用。 而且，他们也无需知道，这是实现的细节，不是接口的契约。 ”

异步方法调用（Asynchronous Method Invocation，简称AMI）

下面这种情况就是AMI调用：“斧头帮”大哥（客户端）叫小弟（服务器端）去干收租的活（远程调用），并且给小弟一把烟花炮竹（回调类）。嘱咐说： “我还有其它事情要打扫打扫，如果你的事情办完了，就放'OK'烟花；如果遇到反抗，就放'斧头'烟花！”(服务器答复)。说完，这位大哥就可以放心的做 其它事去了，直到看到天上烟花盛开，根据"OK"或"斧头"状再作处理。

AMI是针对客户端而言的，当客户端使用AMI发出远程调用时，客户端需要提供一个实现了回调接口的类用于接收通知。然后不等待调用完成立即返回，这时可以继续其它活动，当得到服务器端的答复时，客户端的回调类中的方法就会被执行。

例：修改原Helloworld客户端，使用异步方法远程调用printString。

首先，要修改原来的Printer.ice定义文件，在printString方法前加上["ami"]元标识符。

module Demo{
interface Printer
{
    ["ami"] void printString(string s);
};
};

同样，再用slice2cpp Printer.ice生成Printer.h和Printer.cpp文件，并把这两个文件加入原项目（如果是直接修改之前的代码的话，因为原先已经加入了这两个文件，这步可以跳过）。

观察生成的Printer.h文件，可以找到这个定义：

namespace Demo
{
class AMI_Printer_printString : public ::IceInternal::OutgoingAsync
{
public:
    virtual void ice_response() = 0;
    virtual void ice_exception(const ::Ice::Exception&) = 0;
...
};
}

这里的AMI_Printer_printString就是printString方法的AMI回调接口，可以发现它AMI回调接口类名的规律是AMI_类名_方法名。

这个接口提供了两个方法：

void ice_response(<params>);
    表明操作已成功完成。各个参数代表的是操作的返回值及out 参数。如果操作的有一个非 void返回类型，ice_response 方法的第一个参数就是操作的返回值。操作的所有out 参数都按照声明时的次序，跟在返回值的后面。

void ice_exception(const Ice::Exception &);
    表明抛出了本地或用户异常。

同时，slice2cpp还为Printer代理类生成了异步版本的printString方法：

namespace IceProxy //是代理类
{
namespace Demo
{
class Printer : virtual public ::IceProxy::Ice::Object
{
    ...
public:
    bool printString_async(const ::Demo::AMI_Printer_printStringPtr&,
        const ::std::string&);
    bool printString_async(const ::Demo::AMI_Printer_printStringPtr&,
        const ::std::string&, const ::Ice::Context&);
    ...
};
}
}

结合这两样东西（AMI_Printer_printString接口和printString_async方法），我们的客户端AMI调用方法为：

1. 实现AMI_Printer_printString接口的ice_response和ice_exception方法，以响应远程调用完成后的工作。
2. 把上面实现的回调对象作为printString_async的参数启动远程调用，然后可以做其它事了。
3. 当得到服务端答复后，AMI_Printer_printString接口的ice_response的方法被调用。

 

演示代码(客户端)：

#include <ice/ice.h>
#include <printer.h>

using namespace std;
using namespace Demo;

//实现AMI_Printer_printString接口
struct APP : AMI_Printer_printString
{
    virtual void ice_response()
    {
        cout << "printString完成" << endl;
    }
    virtual void ice_exception(const ::Ice::Exception& e)
    {
        cout << "出错啦：" << e << endl;
    }
};

class MyApp: public Ice::Application{
public:
    virtual int run(int argc, char*argv[])
    {
        Ice::CommunicatorPtr ic = communicator();

        Ice::ObjectPrx base =
            ic->stringToProxy("SimplePrinter:default -p 10000");

        Demo::PrinterPrx printer = PrinterPrx::checkedCast(base);
        if(!printer) throw "Invalid Proxy!";

        // 使用AMI异步调用
        printer->printString_async(new APP,"Hello World!");
        cout << "做点其它的事情..." << endl;
        system("pause");
        return 0;
    }
};

int main(int argc, char* argv[])
{
    MyApp app;
    return app.main(argc,argv);
}

服务端代码不变，编译运行，效果应该是调用printer->printString_async之后还能"做点其它的事情..."，当服务端完成后客户端收到通知，显示"printString完成"。

另外，为了突出异步效果，可以修改服务器端代码，故意把printString执行得慢一点：

struct PrinterImp : Printer{
    virtual void printString(const ::std::string& s,
        const ::Ice::Current&)
    {
        Sleep(1000);
        cout << s << endl;
    }
};

 

 

 

 

直接做具体工作，完成后在末尾调用回调类的ice_response方法告知客户端已完成。这种方案就和之前普通版的服务端一样，是同步执行的。
把回调类和请求所需要的参数放入一个指定的位置，再由其它线程取出执行和通知客户端。这种方案就是异步分派方法，具体实现时还可以有多种 方式，如使用命令模式把参数和具体操作直接封装成一个对象放入队列，然后由另一线程（或线程池）取出执行。后面的示例代码为了简单起见直接使用了 Windows API中的线程池功能，而且也没有使用队列。