last-updated: March 22, 2009
Manual: Mcast shell
owmcastshell - Mcast shell
[-p <shell port>]
[--acl <ACL file>]
[-i <self ID>]
[-m <stat collector addr>[:<port>]]
[-a <algorithm name>]
[-r <routing style>]
[-s [<self address>[:<port>]]|<port>]
Mcast shell is a command language interpreter
which controls Mcast, a higher-level service for multicasting.
It invokes a node on a structured overlay
and controls a Mcast service according to user's instructions
given from standard input and a network.
If command-line arguments are specified,
Mcast shell tries to join an overlay by contacting the specified node.
If an invalid option or -h is specified,
the shell shows help messages.
- -p <shell port>
- Wait on the specified TCP port to read shell instructions.
- --acl <ACL file>
- Read an access control list (ACL) from the specified file.
An ACL file contains lines as follows:
These lines are interpreted from top to bottom.
The first argument can be `allow' or `deny'.
An entry can have a hostname or an IP address as the second argument.
In the above case accesses from 192.168.0.12 and host.example.com are allowed
and accesses from others are prohibited.
- Do not read instructions from standard input.
This option is useful to invoke this tool via a job management system
like Sun N1 Grid Engine.
- -i <self ID>
- Use the specified ID as the ID of the node being invoked itself.
The ID has to be a hexadecimal number.
If no ID is specified, the self ID is determined based on the self address.
- -m <stat collector addr[:<port>]>
- Use the specified address as the address of a statistics collector,
which is Message Counter or Overlay Visualizer.
Mcast shell reports all communication to the specified address
via Messaging Service itself.
- -t < UDP|TCP>
- Use the specified transport protocol.
If no protocol is specified, UDP is used.
- -a <algorithm name>
- Use the specified routing algorithm.
Valid algorithm names are
"Chord", "Kademlia", "Koorde", "LinearWalker", "Pastry", and "Tapestry".
If no algorithm is specified, "Chord" is used.
- -r <routing style>
- Do routing in the specified style.
Valid styles are "Iterative" and "Recursive".
If no style is specified, Mcast shell does "Iterative" routing.
- -s [<self address>[:<port>]]|<port>
- Use the specified address as the address of the node being invoked itself.
If not specified, Mcast shell detects its own address automatically.
But this option is useful on a computer with multiple IP addresses
or inside a NA(P)T router.
- Disable UPnP NAT Traversal function.
Mcast shell reads user's instructions from standard input.
If -p option is specified, it also reads from a network.
It accepts the following instructions.
- init <host>[:<port>] [<port>]
- The node joins an overlay by contacting the specified node.
- join <group name>
- Join the specified group, on which messages are multicasted.
- leave <group name>
- Leave the specified group.
- Leave all groups which the node has joined.
- multicast <group name> <message>
- Multicast the specified message to all nodes in the specified group.
- Print all groups which the node has joined.
- Print neighbor nodes on delivery trees,
on which multicast messages are transferred.
- status [<verbose level>]
- Print routing table contents and result of the last routing.
Some information is omitted
if a negative integer is specified as the verbose level.
- source <file>
- Read shell commands from the specified file and execute them.
The node finds the file from its current directory.
- Print help messages.
- Terminates the shell.
- Terminates the node.
- clear routingtable
- Clears the routing table.
- clear mcast
- Clears states about multicast (e.g. delivery trees) which the node holds.
- Suspend the node, which can be resumed later.
- Resume the node which has been suspended.
Return to Documents page
Return to Overlay Viewer main page