cleos 源碼分析 -- nodeos(一)

http_plugin

http_plugin 用來接受客戶端cleos 發(fā)過來的請求览效,eos 使用多插件機制來拆分業(yè)務(wù)邏輯为严,各plugin 想要相應(yīng)來自客戶端的請求,就需要在各自模塊的api_plugin 中向 http_plugin 注冊 url_handler .

http_plugin 中有個map<string,url_handler> url_handlers;變量垛膝,保管著其他插件注冊過來的接口以及回調(diào)鳍侣。

http_plugin 中的 add_api 方法 以及 add_handler:

void add_api(const api_description& api) {
   for (const auto& call : api) 
      add_handler(call.first, call.second);
}

void http_plugin::add_handler(const string& url, const url_handler& handler) {
  ilog( "add api url: ${c}", ("c",url) );
  app().get_io_service().post([=](){
    my->url_handlers.insert(std::make_pair(url,handler));
  });
}

http_plugin 中處理http請求的函數(shù), 通過handler_itr->second(...)來調(diào)用具體邏輯。

template<class T>
 void handle_http_request(typename websocketpp::server<detail::asio_with_stub_log<T>>::connection_ptr con) {
    try {
       
       ......

       con->append_header( "Content-type", "application/json" );
       auto body = con->get_request_body();
       auto resource = con->get_uri()->get_resource();
       auto handler_itr = url_handlers.find( resource );
       if( handler_itr != url_handlers.end()) {
          con->defer_http_response();
          
          // 調(diào)用其他模塊注冊過來的回調(diào)
          handler_itr->second( resource, body, [con]( auto code, auto&& body ) {
             con->set_body( std::move( body ));
             con->set_status( websocketpp::http::status_code::value( code ));
             con->send_http_response();
          } );

       } else {
          wlog( "404 - not found: ${ep}", ("ep", resource));
          error_results results{websocketpp::http::status_code::not_found,
                                "Not Found", error_results::error_info(fc::exception( FC_LOG_MESSAGE( error, "Unknown Endpoint" )), verbose_http_errors )};
          con->set_body( fc::json::to_string( results ));
          con->set_status( websocketpp::http::status_code::not_found );
       }
    } catch( ... ) {
       handle_exception<T>( con );
    }
 }

chain_plugin

要知道chain_plugin對外提供什么功能吼拥,首先看 chain_api_plugin

chain_api_plugin 中主要分了兩個 api: read_onlyread_write 兩個類處理倚聚。

void chain_api_plugin::plugin_startup() {
   ilog( "starting chain_api_plugin" );
   my.reset(new chain_api_plugin_impl(app().get_plugin<chain_plugin>().chain()));
   auto ro_api = app().get_plugin<chain_plugin>().get_read_only_api();
   auto rw_api = app().get_plugin<chain_plugin>().get_read_write_api();

   app().get_plugin<http_plugin>().add_api({
      CHAIN_RO_CALL(get_info, 200l),
      CHAIN_RO_CALL(get_block, 200),
      CHAIN_RO_CALL(get_block_header_state, 200),
      CHAIN_RO_CALL(get_account, 200),
      CHAIN_RO_CALL(get_code, 200),
      CHAIN_RO_CALL(get_abi, 200),
      CHAIN_RO_CALL(get_raw_code_and_abi, 200),
      CHAIN_RO_CALL(get_table_rows, 200),
      CHAIN_RO_CALL(get_currency_balance, 200),
      CHAIN_RO_CALL(get_currency_stats, 200),
      CHAIN_RO_CALL(get_producers, 200),
      CHAIN_RO_CALL(get_producer_schedule, 200),
      CHAIN_RO_CALL(get_scheduled_transactions, 200),
      CHAIN_RO_CALL(abi_json_to_bin, 200),
      CHAIN_RO_CALL(abi_bin_to_json, 200),
      CHAIN_RO_CALL(get_required_keys, 200),
      CHAIN_RW_CALL_ASYNC(push_block, chain_apis::read_write::push_block_results, 202),
      CHAIN_RW_CALL_ASYNC(push_transaction, chain_apis::read_write::push_transaction_results, 202),
      CHAIN_RW_CALL_ASYNC(push_transactions, chain_apis::read_write::push_transactions_results, 202)
   });
}

可以看到,plugin_startup 函數(shù)向 http_plugin 插件添加了若干個接口凿可,

CHAIN_RW_CALL_ASYNC 定義如下:

#define CHAIN_RW_CALL_ASYNC(call_name, call_result, http_response_code) CALL_ASYNC(chain, rw_api, chain_apis::read_write, call_name, call_result, http_response_code)

#define CALL_ASYNC(api_name, api_handle, api_namespace, call_name, call_result, http_response_code) \
{std::string("/v1/" #api_name "/" #call_name), \
   [this, api_handle](string, string body, url_response_callback cb) mutable { \
      if (body.empty()) body = "{}"; \
      api_handle.call_name(fc::json::from_string(body).as<api_namespace::call_name ## _params>(),\
         [cb, body](const fc::static_variant<fc::exception_ptr, call_result>& result){\
            if (result.contains<fc::exception_ptr>()) {\
               try {\
                  result.get<fc::exception_ptr>()->dynamic_rethrow_exception();\
               } catch (...) {\
                  http_plugin::handle_exception(#api_name, #call_name, body, cb);\
               }\
            } else {\
               cb(http_response_code, result.visit(async_result_visitor()));\
            }\
         });\
   }\
}

最終定義的是一個map, key 是注冊的url地址惑折, value 是回調(diào) lambada

例如 CHAIN_RW_CALL_ASYNC(push_block, chain_apis::read_write::push_block_results, 202), 就是向 http_plugin 注冊了 /v1/chain/push_block 接口,該接口被調(diào)用后矿酵,會轉(zhuǎn)向 chain_pluginread_write 類的 push_block 方法唬复,

看看 push_block 方法的定義:


void read_write::push_block(const read_write::push_block_params& params, next_function<read_write::push_block_results> next) {
   try {
      app().get_method<incoming::methods::block_sync>()(std::make_shared<signed_block>(params));
      // 直接向客戶端返回了空的結(jié)果
      next(read_write::push_block_results{});
   } catch ( boost::interprocess::bad_alloc& ) {
      raise(SIGUSR1);
   } CATCH_AND_CALL(next);
}

重點在于這行代碼

app().get_method<incoming::methods::block_sync>()(std::make_shared<signed_block>(params));

先看前面一半: app().get_method<incoming::methods::block_sync>()
調(diào)用applicationget_method 方法,

 template<typename MethodDecl>
 auto get_method() -> std::enable_if_t<is_method_decl<MethodDecl>::value, typename MethodDecl::method_type&>
 {
    using method_type = typename MethodDecl::method_type;
    auto key = std::type_index(typeid(MethodDecl));
    auto itr = methods.find(key);
    if(itr != methods.end()) {
       return *method_type::get_method(itr->second);
    } else {
       methods.emplace(std::make_pair(key, method_type::make_unique()));
       return  *method_type::get_method(methods.at(key));
    }
 }

auto key = std::type_index(typeid(MethodDecl)); 是一個類模版特化全肮,可以將模版名轉(zhuǎn)換為字符串 敞咧,參考鏈接
methods 會查找這個key,如果不存在就新建辜腺,

incoming::methods::block_sync 類型定義如下:

namespace incoming {
  namespace methods {
     // synchronously push a block/trx to a single provider
     using block_sync   = method_decl<chain_plugin_interface, void(const signed_block_ptr&), first_provider_policy>;
  }
}

method_decl 定義又如下

   template< typename Tag, typename FunctionSig, template <typename> class DispatchPolicy = first_success_policy>
   struct method_decl {
      using method_type = method<FunctionSig, DispatchPolicy<FunctionSig>>;
      using tag_type = Tag;
   };
using method_type = typename MethodDecl::method_type;

翻譯如下:
using method_type = method<void(const signed_block_ptr&), first_success_policy>

查看method定義休建,繼承自 method_caller

method_caller 中定義了signal_typeboost庫中的signal 類型:
boost::signals2::signal<void(Args...), DispatchPolicy>;

并重載了()函數(shù):

void operator()(Args&&... args)
{
   _signal(std::forward<Args>(args)...);
}

signal 直接發(fā)出信號

回到上面
app().get_method<incoming::methods::block_sync>()(std::make_shared<signed_block>(params))

最終拿到一個 chain_plugin_interface 類型的信號乍恐,將事件發(fā)出,供其他plugin接受测砂,plugin 之間的通信用這種方式可以減少耦合

全局查找 incoming::methods::block_sync 會發(fā)現(xiàn)茵烈,在 producer_plugin 中注冊了此類信號的回調(diào)

my->_incoming_block_sync_provider = app().get_method<incoming::methods::block_sync>().register_provider([this](const signed_block_ptr& block){
  my->on_incoming_block(block);
});

這里沒有深入討論 boost 庫的 signal 機制。只是簡單闡述調(diào)用流程砌些。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末呜投,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子存璃,更是在濱河造成了極大的恐慌仑荐,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,539評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件纵东,死亡現(xiàn)場離奇詭異粘招,居然都是意外死亡,警方通過查閱死者的電腦和手機偎球,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,594評論 3 396
  • 文/潘曉璐 我一進店門洒扎,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人衰絮,你說我怎么就攤上這事袍冷。” “怎么了岂傲?”我有些...
    開封第一講書人閱讀 165,871評論 0 356
  • 文/不壞的土叔 我叫張陵难裆,是天一觀的道長。 經(jīng)常有香客問我镊掖,道長,這世上最難降的妖魔是什么褂痰? 我笑而不...
    開封第一講書人閱讀 58,963評論 1 295
  • 正文 為了忘掉前任亩进,我火速辦了婚禮,結(jié)果婚禮上缩歪,老公的妹妹穿的比我還像新娘归薛。我一直安慰自己,他們只是感情好匪蝙,可當(dāng)我...
    茶點故事閱讀 67,984評論 6 393
  • 文/花漫 我一把揭開白布主籍。 她就那樣靜靜地躺著,像睡著了一般逛球。 火紅的嫁衣襯著肌膚如雪千元。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,763評論 1 307
  • 那天颤绕,我揣著相機與錄音幸海,去河邊找鬼祟身。 笑死,一個胖子當(dāng)著我的面吹牛物独,可吹牛的內(nèi)容都是我干的袜硫。 我是一名探鬼主播,決...
    沈念sama閱讀 40,468評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼挡篓,長吁一口氣:“原來是場噩夢啊……” “哼婉陷!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起官研,我...
    開封第一講書人閱讀 39,357評論 0 276
  • 序言:老撾萬榮一對情侶失蹤秽澳,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后阀参,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體肝集,經(jīng)...
    沈念sama閱讀 45,850評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,002評論 3 338
  • 正文 我和宋清朗相戀三年蛛壳,在試婚紗的時候發(fā)現(xiàn)自己被綠了杏瞻。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,144評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡衙荐,死狀恐怖捞挥,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情忧吟,我是刑警寧澤砌函,帶...
    沈念sama閱讀 35,823評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站溜族,受9級特大地震影響讹俊,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜煌抒,卻給世界環(huán)境...
    茶點故事閱讀 41,483評論 3 331
  • 文/蒙蒙 一仍劈、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧寡壮,春花似錦贩疙、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,026評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至棒仍,卻和暖如春悲靴,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背降狠。 一陣腳步聲響...
    開封第一講書人閱讀 33,150評論 1 272
  • 我被黑心中介騙來泰國打工对竣, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留庇楞,地道東北人。 一個月前我還...
    沈念sama閱讀 48,415評論 3 373
  • 正文 我出身青樓否纬,卻偏偏與公主長得像吕晌,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子临燃,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,092評論 2 355

推薦閱讀更多精彩內(nèi)容