YUKI Hiroshi
null+****@clear*****
Mon Feb 17 18:17:14 JST 2014
YUKI Hiroshi 2014-02-17 18:17:14 +0900 (Mon, 17 Feb 2014) New Revision: a8287dca5573ebfd34e1bc876b10c3e4942df1e6 https://github.com/droonga/droonga.org/commit/a8287dca5573ebfd34e1bc876b10c3e4942df1e6 Message: Update descriptions about configurations of adapters Modified files: reference/plugin/adapter/index.md reference/plugin/index.md Modified: reference/plugin/adapter/index.md (+9 -8) =================================================================== --- reference/plugin/adapter/index.md 2014-02-17 17:57:39 +0900 (5fb8367) +++ reference/plugin/adapter/index.md 2014-02-17 18:17:14 +0900 (d1d1f32) @@ -64,12 +64,12 @@ An adapter works like following: * The Droonga Engine starts to wait for incoming messages. 2. An incoming message is transferred from the Protocol Adapter to the Droonga Engine. Then, the adaption phase (for an incoming message) starts. - * The adapter's [`#adapt_input`](#classes-Droonga-Adapter-adapt_input) is called, if the message matches to the input pattern. + * The adapter's [`#adapt_input`](#classes-Droonga-Adapter-adapt_input) is called, if the message matches to the [input matching pattern](#config). * The method can modify the given incoming message, via [its methods](#classes-Droonga-InputMessage). 3. After all adapters are applied, the adaption phase for an incoming message ends, and the message is transferred to the next "planning" phase. 4. An outgoing message returns from the previous "collection" phase. Then, the adaption phase (for an outgoing message) starts. - * The adapter's [`#adapt_output`](#classes-Droonga-Adapter-adapt_output) is called, if the corresponding incoming message was processed by the adapter and the outgoing message matches to the output pattern. + * The adapter's [`#adapt_output`](#classes-Droonga-Adapter-adapt_output) is called, if the corresponding incoming message was processed by the adapter and the outgoing message matches to the [output matching pattern](#config). * The method can modify the given outgoing message, via [its methods](#classes-Droonga-OutputMessage). 5. After all adapters are applied, the adaption phase for an outgoing message ends, and the outgoing message is transferred to the Protocol Adapter. @@ -80,13 +80,13 @@ Instead, you should give stateful information as a part of the incoming message ## Configurations {#config} -### `input_message.pattern` {#config-input_message-pattern} +`input_message.pattern` +: A [matching pattern] for incoming messages. + Only messages matched to the given patten are processed by [`#adapt_input`](#classes-Droonga-Adapter-adapt_input). -(TBD) - -### `output_message.pattern` {#config-output_message-pattern} - -(TBD) +`output_message.pattern` +: A [matching pattern] for outgoing messages. + Only messages matched to the given patten are processed by [`#adapt_output`](#classes-Droonga-Adapter-adapt_output). ## Error handling {#error} @@ -180,3 +180,4 @@ end + [matching pattern]: ../matching-pattern/ Modified: reference/plugin/index.md (+1 -0) =================================================================== --- reference/plugin/index.md 2014-02-17 17:57:39 +0900 (bc2f6ef) +++ reference/plugin/index.md 2014-02-17 18:17:14 +0900 (237219c) @@ -8,3 +8,4 @@ See also the [plugin development tutorial](../../tutorial/plugin-development/). * [API set for the adaption phase](adapter/) * [API set for the handling phase](handler/) + * [Matching pattern for messages](matching-pattern/) -------------- next part -------------- HTML����������������������������...ダウンロード
