[Groonga-commit] droonga/droonga.org at cb973f5 [gh-pages] List both signatures

Back to archive index

YUKI Hiroshi null+****@clear*****
Mon Feb 17 17:15:16 JST 2014


YUKI Hiroshi	2014-02-17 17:15:16 +0900 (Mon, 17 Feb 2014)

  New Revision: cb973f51c82093529f43a81069abb18f881d319c
  https://github.com/droonga/droonga.org/commit/cb973f51c82093529f43a81069abb18f881d319c

  Message:
    List both signatures

  Modified files:
    reference/plugin/adapter/index.md

  Modified: reference/plugin/adapter/index.md (+23 -10)
===================================================================
--- reference/plugin/adapter/index.md    2014-02-17 17:01:19 +0900 (416e943)
+++ reference/plugin/adapter/index.md    2014-02-17 17:15:16 +0900 (7bd4cc9)
@@ -80,13 +80,26 @@ This is the common base class of any adapter. Your plugin's adapter class must i
 
 #### `.message` {#classes-Droonga-Adapter-class-message}
 
-(under construction)
+Returns an instance of [`Droonga::Plugin::Metadata::AdapterMessage`](#classes-Droonga-Plugin-Metadata-AdapterMessage) for the class itself. You can configure your adapter via this, like a DSL. For example:
+
+~~~ruby
+module FooPlugin
+  class Adapter < Droonga::Adapter
+    message.input_pattern = ["type", :equal, "foo"]
+    message.output_pattern = ["body.success", :exist?]
+  end
+end
+~~~
+
+Don't override this method because it is managed by the Droonga Engine itself.
+
+#### `#adapt_input(input_message)` {#classes-Droonga-Adapter-adapt_input}
+
 
-#### `#adapt_input` {#classes-Droonga-Adapter-adapt_input}
 
 (under construction)
 
-#### `#adapt_output` {#classes-Droonga-Adapter-adapt_output}
+#### `#adapt_output(output_message)` {#classes-Droonga-Adapter-adapt_output}
 
 (under construction)
 
@@ -94,11 +107,11 @@ This is the common base class of any adapter. Your plugin's adapter class must i
 
 (under construction)
 
-#### `#input_pattern` {#classes-Droonga-Plugin-Metadata-AdapterMessage-input_pattern}
+#### `#input_pattern`, `#input_pattern=(pattern)` {#classes-Droonga-Plugin-Metadata-AdapterMessage-input_pattern}
 
 (under construction)
 
-#### `#output_pattern` {#classes-Droonga-Plugin-Metadata-AdapterMessage-output_pattern}
+#### `#output_pattern`, `#output_pattern=(pattern)` {#classes-Droonga-Plugin-Metadata-AdapterMessage-output_pattern}
 
 (under construction)
 
@@ -106,11 +119,11 @@ This is the common base class of any adapter. Your plugin's adapter class must i
 
 (under construction)
 
-#### `#command` {#classes-Droonga-InputMessage-command}
+#### `#command`, `#command=(command)` {#classes-Droonga-InputMessage-command}
 
 (under construction)
 
-#### `#body` {#classes-Droonga-InputMessage-body}
+#### `#body`, `#body=(body)` {#classes-Droonga-InputMessage-body}
 
 (under construction)
 
@@ -118,15 +131,15 @@ This is the common base class of any adapter. Your plugin's adapter class must i
 
 (under construction)
 
-#### `#status_code` {#classes-Droonga-OutputMessage-status_code}
+#### `#status_code`, `#status_code=(status_code)` {#classes-Droonga-OutputMessage-status_code}
 
 (under construction)
 
-#### `#errors` {#classes-Droonga-OutputMessage-errors}
+#### `#errors`, `#errors=(errors)` {#classes-Droonga-OutputMessage-errors}
 
 (under construction)
 
-#### `#body` {#classes-Droonga-OutputMessage-body}
+#### `#body`, `#body=(body)` {#classes-Droonga-OutputMessage-body}
 
 (under construction)
 
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Back to archive index