Network Layer Overview

Brief

There are numerious connections and processes required for the kit. This document will provide an overview of the high level network layer for all Python network connections. This document does not contain TGE(A) network layer information.

Ports and Interfaces

Below is a modified UML diagram displaying network connections between components. The symbol indicates a provided port. This is the server side of a connection listening to a port. The symbol indicates a required port. This is the client side of a connection connecting to a port.

Interfaces are indicated as underlined text within a rectangle. Interfaces are used to describe or limit how a component may communicate with another component. Interfaces can be associated with a port. This association is shown by continuing the provided or required port line to the interface.

Not all required ports are associated with a defined interface. This is indicated by the required port line only being drawn to the edge of the component. In these situations, the requiring component does not directly supply an interface for the providing component, but may provide a series of callbacks instead. Additionally, the requiring component may not need to maintain the connection, as it may only be making a single call to the provided component.

Components

CharacterServer

Provided Ports

None.

Required Ports

Protocol	IP	Port	Connection Setting	Notes
TCP	GMSERVER_IP	GMSERVER_IP	./mud/characterserver/config.py	None.
TCP	Master IP	Master Port	./serverconfig/server.cfg	None.
TCP	world IP	world Port	Provided by MasterServer when WorldDaemon announces World.	None.

---

Client

Provided Ports

None.

Required Ports

Protocol	IP	Port	Connection Setting	Notes
TCP	$Py::MasterIP	$Py::MasterPort	./main.cs	None.
TCP	world IP	world Port	Provided by MasterServer for announced Worlds.	None.

---

GMServer

Provided Ports

Protocol	Port	Connection Setting	Notes
TCP	1998	./mud/gmserver/gmserver.py	None.

Required Ports

None.

---

MasterServer

Provided Ports

Protocol	Port	Connection Setting	Notes
TELNET	Manhole Port	./serverconfig/server.cfg.	Connection requires addition credentials: Allowed IPs (./mud/masterserver/main.py), and Manhole Username and Manhole Password (./serverconfig/server.cfg).
TCP	Master Port	./serverconfig/server.cfg	None.

Required Ports

None.

---

Simulation

Provided Ports

None.

Required Ports

Protocol	IP	Port	Connection Setting	Notes
TCP	127.0.0.1	$Py::WorldPort	Command Line Argument	-worldport argument provided for ZoneServer process. Locally spawned from ./mud/world/theworld.py.

---

WorldDaemon

Provided Ports

Protocol	Port	Connection Setting	Notes
TCP	7000	./mud/worddaemon/worldservices.py	Listens for WorldServer
TCP	7001	./mud/worddaemon/charservices.py	Listens for CharacterServer
TELNET	7002	./mud/worddaemon/main.py	The Telnet namespace can allow remotely launched commands. Remote shutdown and reboots are in the default namespace.
TCP	7005	./mud/worddaemon/worldimp.py	Listens for WorldImps

Required Ports

Protocol	IP	Port	Connection Setting	Notes
TCP	MASTERIP	MASTERPORT	./mud.gamesettings.py	None.

---

WorldImp

Provided Ports

None.

Required Ports

Protocol	IP	Port	Connection Setting	Notes
TCP	IP	PORT	Command Line Arguments	-daemonip and -daemonport arguments for WorldImp process.

---

WorldServer

Provided Ports

Protocol	Port	Connection Setting	Notes
SSH	SSH_PORT	./serverconfig/world_name.py	Connection requires addition credentials: Allowed IPs (SSH_IPS) in ./serverconfig/world_name.py.
TCPIP	WORLDPORT	./serverconfig/world_name.py	None.

Required Ports

Protocol	IP	Port	Connection Setting	Notes
TCP	DAEMONIP	7000	./mud/worldserver/main.py	DAEMONIP defaults to 127.0.0.1 for a (local) World.
TCP	IP	PORT	Command Line Arguments	-daemonip and -daemonport arguments for WorldImp process that spawns the (remote) World in ./mud/worlddaemon/worldimp.py.