Module: JSCommander

Defined in:

lib/jscmd/message.rb,
lib/jscmd/shell.rb,
lib/jscmd/pipebroker.rb,
lib/jscmd/stompproxy.rb,
lib/jscmd/proxyserver.rb,
lib/jscmd/urlforwarder.rb,
lib/jscmd/inprocessbroker.rb

Overview

Messages sent between clients and broker

• Topic “events”: proxy -> broker -> shell

Common attributes: type - Type of the message. (e.g. “connect”) clients - List of clients that are connected. (e.g. “[www.google.com],[www.yahoo.com]”) in-reply-to - id of the command that caused this message (optional; only used with “value”, “error” and “pong” types)

Types: connect - Notify that the new client has connected. The body must be empty. abort - Notify that the client aborted. The body must be empty. pong - Reply to “ping” command. body must be empty. value - Send value with body. error - Send error message with body.

• Topic “commands”: shell -> broker -> proxy

Common attributes: type - Type of the message. (e.g. “eval”) id - unique value that identifies this command. (optional; only used with “eval” and “properties” types)

Types: ping - Request the status of clients from shell to proxy server. It will not be routed to web browser. The body must be empty. nop - Empty message sent from proxy server to web browser when there were no commands within reconnect_interval seconds. eval - Evaluate body. properties - Evaluate body and get list of properties.

Defined Under Namespace

Classes: InProcessBroker, Message, PipeBroker, ProxyServer, Shell, StompProxy, URLForwarder