Changeset 532

Timestamp:

10/19/07 15:45:55 (6 years ago)

Author:

typester

Message:

lang/perl/POE-Component-Server-JSONRPC: Added documentation

Files:

• lang/perl/POE-Component-Server-JSONRPC/trunk/lib/POE/Component/Server/JSONRPC.pm (modified) (4 diffs)

lang/perl/POE-Component-Server-JSONRPC/trunk/lib/POE/Component/Server/JSONRPC.pm

@@ -8 +8 @@
 use POE qw/
     Component::Server::TCP
-    Filter::Stackable
-    Filter::JSON
     Filter::Line
     /;
@@ -16 +14 @@
 =head1 NAME
 
-POE::Component::Server::JSONRPC - Module abstract (<= 44 characters) goes here
+POE::Component::Server::JSONRPC - POE tcp based JSON-RPC server
 
 =head1 SYNOPSIS
@@ -42 +40 @@
 =head1 DESCRIPTION
 
-Stub documentation for this module was created by ExtUtils::ModuleMaker.
-It looks like the author of the extension was negligent enough
-to leave the stub unedited.
-
-Blah blah blah.
+This module is a POE component for tcp based JSON-RPC Server.
+
+The specification is defined on http://json-rpc.org/ and this module use JSON-RPC 1.0 spec (1.1 does not cover tcp streams)
 
 =head1 METHODS
 
 =head2 new
+
+Create JSONRPC component session and return the session id.
+
+Parameters:
+
+=over
+
+=item Port
+
+Port number for listen.
+
+=item Handler
+
+Hash variable contains handler name as key, handler poe state name as value.
+
+Handler name (key) is used as JSON-RPC method name.
+
+So if you send {"method":"echo"}, this module call the poe state named "echo".
+
+=back
 
 =cut
@@ -72 +88 @@
 }
 
+=head1 HANDLER PARAMETERS
+
+=over
+
+=item ARG0
+
+A session id of PoCo::Server::JSONRPC itself.
+
+=item ARG1 .. ARGN
+
+JSONRPC argguments
+
+=back
+
+ex) If you send following request
+
+    {"method":"echo", "params":["foo", "bar"]}
+
+then, "echo" handler is called and parameters is that ARG0 is component session id, ARG1 "foo", ARG2 "bar".
+
+=head1 HANDLER RESPONSE
+
+You must call either "result" or "error" state in your handlers to response result or error.
+
+ex:
+
+   $kernel->post( $component_session_id => "result" => "result value" )
+
+$component_session_id is ARG0 in handler. If you do above, response is:
+
+   {"result":"result value", "error":""}
+
+
 =head1 POE METHODS
+
+Inner method for POE states.
 
 =head2 poe__start