YUKI Hiroshi
null+****@clear*****
Fri Feb 28 16:46:16 JST 2014
YUKI Hiroshi 2014-02-28 16:46:16 +0900 (Fri, 28 Feb 2014) New Revision: 1e11d211fb087e70cfb76e4e1de909b19f024d80 https://github.com/droonga/droonga.org/commit/1e11d211fb087e70cfb76e4e1de909b19f024d80 Message: Update ja version Modified files: _po/ja/reference/plugin/handler/index.po ja/reference/plugin/handler/index.md Modified: _po/ja/reference/plugin/handler/index.po (+30 -30) =================================================================== --- _po/ja/reference/plugin/handler/index.po 2014-02-28 16:44:05 +0900 (41c2185) +++ _po/ja/reference/plugin/handler/index.po 2014-02-28 16:46:16 +0900 (a52adca) @@ -68,12 +68,12 @@ msgstr "" msgid "" " 1. Define a module for your plugin (ex. `Droonga::Plugins::FooPlugin`) and re" "gister it as a plugin. (required)\n" -" 2. Define a \"single step\" corresponding to the Configure conditions for the h" -"andler. (required)\n" +" 2. Define a \"single step\" corresponding to the handler you are going to imple" +"ment. (required)\n" " 2. Define a handler class (ex. `Droonga::Plugins::FooPlugin::Handler`) inheri" "ting [`Droonga::Handler`](#classes-Droonga-Handler). (required)\n" -" 4. Define handling logic for incoming messages as [`#handle`](#classes-Droong" -"a-Handler-handle). (optional)" +" 4. Define handling logic for requests as [`#handle`](#classes-Droonga-Handler" +"-handle). (optional)" msgstr "" msgid "" @@ -89,28 +89,30 @@ msgstr "" msgid "" " 1. The Droonga Engine starts.\n" -" * A global instance of the handler class (ex. `Droonga::Plugins::FooPlugin" -"::Handler`) is created and it is registered.\n" -" * The message type is registered.\n" -" * The Droonga Engine starts to wait for incoming messages.\n" -" 2. An incoming message is transferred from the planning phase.\n" -" Then, the handling phase starts.\n" -" * The Droonga Engine finds the handler from the message type.\n" -" * Found handler's [`#handle`](#classes-Droonga-Handler-handle) is called w" -"ith the incoming message.\n" -" * The method can process the given incoming message as you like.\n" -" * The method can output any message as you like.\n" -" * If no handler is found for the type, nothing happens.\n" -" 3. After the handler finishes (or no handler is found), the handling phase fo" -"r the incoming message ends." +" * Your custom steps are registered.\n" +" Your custom handler classes also.\n" +" * Then the Droonga Engine starts to wait for request messages.\n" +" 2. A request message is transferred from the adaption phase.\n" +" Then, the processing phase starts.\n" +" * The Droonga Engine finds a step definition from the message type.\n" +" * The Droonga Engine builds a \"single step\" based on the registered defini" +"tion.\n" +" * A \"single step\" creates an instance of the registered handler class.\n" +" Then the Droonga Engine enters to the handling phase.\n" +" * The handler's [`#handle`](#classes-Droonga-Handler-handle) is called w" +"ith a task massage including the request.\n" +" * The method can process the given incoming message as you like.\n" +" * The method returns a result value, as the output.\n" +" * After the handler finishes, the handling phase for the task message (a" +"nd the request) ends.\n" +" * If no \"step\" is found for the type, nothing happens.\n" +" * All \"step\"s finish their task, the processing phase for the request ends" +"." msgstr "" msgid "" -"As described above, the Droonga Engine creates only one global instance of the" -" handler class for each plugin.\n" -"You should not keep stateful information as instance variables of the handler " -"itself.\n" -"Instead, you should use the body of messages." +"As described above, the Droonga Engine creates an instance of the handler clas" +"s for each request." msgstr "" msgid "" @@ -122,11 +124,6 @@ msgid "## Configurations {#config}" msgstr "" msgid "" -"`message.type` (`String`, required)\n" -": (TBD)" -msgstr "" - -msgid "" "`action.synchronous` (boolean, optional, default=false)\n" ": (TBD)" msgstr "" @@ -142,12 +139,12 @@ msgid "" " inherit this." msgstr "" -msgid "#### `#handle(message, messenger)` {#classes-Droonga-Handler-handle}" +msgid "#### `#handle(message)` {#classes-Droonga-Handler-handle}" msgstr "" msgid "" "This method receives a [`Droonga::HandlerMessage`](#classes-Droonga-HandlerMes" -"sage) wrapped incoming message." +"sage) wrapped task message." msgstr "" msgid "(TBD)" @@ -159,5 +156,8 @@ msgstr "" msgid "#### `#request` {#classes-Droonga-HandlerMessage-request}" msgstr "" +msgid "Returns the request message." +msgstr "" + msgid " [error handling]: ../error/" msgstr "" Modified: ja/reference/plugin/handler/index.md (+23 -22) =================================================================== --- ja/reference/plugin/handler/index.md 2014-02-28 16:44:05 +0900 (1eeffd0) +++ ja/reference/plugin/handler/index.md 2014-02-28 16:46:16 +0900 (9d15cfb) @@ -50,9 +50,9 @@ end Steps to define a handler: 1. Define a module for your plugin (ex. `Droonga::Plugins::FooPlugin`) and register it as a plugin. (required) - 2. Define a "single step" corresponding to the Configure conditions for the handler. (required) + 2. Define a "single step" corresponding to the handler you are going to implement. (required) 2. Define a handler class (ex. `Droonga::Plugins::FooPlugin::Handler`) inheriting [`Droonga::Handler`](#classes-Droonga-Handler). (required) - 4. Define handling logic for incoming messages as [`#handle`](#classes-Droonga-Handler-handle). (optional) + 4. Define handling logic for requests as [`#handle`](#classes-Droonga-Handler-handle). (optional) See also the [plugin development tutorial](../../../tutorial/plugin-development/handler/). @@ -62,30 +62,29 @@ See also the [plugin development tutorial](../../../tutorial/plugin-development/ A handler works like following: 1. The Droonga Engine starts. - * A global instance of the handler class (ex. `Droonga::Plugins::FooPlugin::Handler`) is created and it is registered. - * The message type is registered. - * The Droonga Engine starts to wait for incoming messages. - 2. An incoming message is transferred from the planning phase. - Then, the handling phase starts. - * The Droonga Engine finds the handler from the message type. - * Found handler's [`#handle`](#classes-Droonga-Handler-handle) is called with the incoming message. - * The method can process the given incoming message as you like. - * The method can output any message as you like. - * If no handler is found for the type, nothing happens. - 3. After the handler finishes (or no handler is found), the handling phase for the incoming message ends. - -As described above, the Droonga Engine creates only one global instance of the handler class for each plugin. -You should not keep stateful information as instance variables of the handler itself. -Instead, you should use the body of messages. + * Your custom steps are registered. + Your custom handler classes also. + * Then the Droonga Engine starts to wait for request messages. + 2. A request message is transferred from the adaption phase. + Then, the processing phase starts. + * The Droonga Engine finds a step definition from the message type. + * The Droonga Engine builds a "single step" based on the registered definition. + * A "single step" creates an instance of the registered handler class. + Then the Droonga Engine enters to the handling phase. + * The handler's [`#handle`](#classes-Droonga-Handler-handle) is called with a task massage including the request. + * The method can process the given incoming message as you like. + * The method returns a result value, as the output. + * After the handler finishes, the handling phase for the task message (and the request) ends. + * If no "step" is found for the type, nothing happens. + * All "step"s finish their task, the processing phase for the request ends. + +As described above, the Droonga Engine creates an instance of the handler class for each request. Any error raised from the handler is handled by the Droonga Engine itself. See also [error handling][]. ## Configurations {#config} -`message.type` (`String`, required) -: (TBD) - `action.synchronous` (boolean, optional, default=false) : (TBD) @@ -96,9 +95,9 @@ Any error raised from the handler is handled by the Droonga Engine itself. See a This is the common base class of any handler. Your plugin's handler class must inherit this. -#### `#handle(message, messenger)` {#classes-Droonga-Handler-handle} +#### `#handle(message)` {#classes-Droonga-Handler-handle} -This method receives a [`Droonga::HandlerMessage`](#classes-Droonga-HandlerMessage) wrapped incoming message. +This method receives a [`Droonga::HandlerMessage`](#classes-Droonga-HandlerMessage) wrapped task message. (TBD) @@ -106,6 +105,8 @@ This method receives a [`Droonga::HandlerMessage`](#classes-Droonga-HandlerMessa #### `#request` {#classes-Droonga-HandlerMessage-request} +Returns the request message. + (TBD) [error handling]: ../error/ -------------- next part -------------- HTML����������������������������...Download