extra/concurrency/distributed/distributed-docs.factor

   1 USING: help.markup help.syntax concurrency ;
   2 IN: concurrency.distributed
   3
   4 HELP: <remote-process>
   5 { $values { "node" "a node object" }
   6           { "pid" "a process id" }
   7           { "remote-process" "the constructed remote-process object" }
   8 }
   9 { $description "Constructs a proxy to a process running on another node. It can be used to send messages to the process it is acting as a proxy for." }
  10 { $see-also <node> <process> spawn send } ;
  11
  12
  13 HELP: <node>
  14 { $values { "hostname" "the hostname of the node as a string" }
  15           { "port" "the integer port number of the node" }
  16           { "node" "the constructed node object" }
  17 }
  18 { $description "Processes run on nodes. Each node has a hostname and a port." }
  19 { $see-also localnode } ;
  20
  21 HELP: localnode
  22 { $values { "node" "a node object" }
  23 }
  24 { $description "Return the node the process is currently running on." }
  25 { $see-also <node> } ;