Permalink
Browse files

README added as a initial file for the public repository of sshrpc

  • Loading branch information...
0 parents commit c9c5ff0163506504ad08659e4d8e243c96ee2fe6 @jj1bdx committed Feb 21, 2010
Showing with 50 additions and 0 deletions.
  1. +50 −0 README
50 README
@@ -0,0 +1,50 @@
+sshrpc readme.txt
+by Kenji Rikitake
+
+This is sshrpc, an experimental module for Erlang RPC over SSH.
+WARNING: this code should not be used for a production system.
+
+* ssh module configuration requirement
+
+Option {nodelay, true} MUST be set on both sides of
+ssh:connect and ssh:daemon, for ensuring immediate
+answers during the exchange.
+
+* subsystem
+
+sshrpc is implemented as an SSH subsystem, named as
+ sshrpc@k2r.org
+Note: this name is local and temporary
+
+subsystem code: sshrpc_subsystem.erl
+
+* client code
+
+client code is still incomplete and under development.
+
+* SSH channel usage
+
+sshrpc uses SSH Channel Type 0 for RPC exchange.
+Usage for other Types are reserved.
+Out-of-band signaling is not implemented.
+
+* RPC exchange format
+
+Larger binary packet for each exchange:
+ << Length:32/unsigned-big-integer,
+ %% 4-byte binary (?UINT32())
+ Content/binary
+ %% of Erlang External Format of Length bytes
+ >>
+
+Content for each exchange contains tuples only.
+
+Command tuples:
+
+{mfa, {Module, Function, Args}}
+ execute erlang:apply(Module, Function, Args) at the server node.
+
+{answer, {Reply, Status}}
+ result of the {mfa, {...}} command tuple.
+
+[End of memorandum]

0 comments on commit c9c5ff0

Please sign in to comment.