SATYR NETWORK INTERFACE MODULE GUIDE

Jon S. <jon@bzap.org>
April 9, 2020
http://www.centaur.pw/ | https://www.bzap.org/

INSTALLATION

	Before installing this module, change the #12 shown in the first two lines to the result of:

		;toobj(toint(max_object()) + 1)

	To install, paste the full text of mod_network.v to the server while logged in as an administrator.

ABOUT THIS GUIDE

	Network Inteface Module - This module adds commands enabling the user to open and interact with TCP/IP
	connections from within the Satyr database. It is very useful for porting code.

	Required arguments are enclosed in arrow brackets <>.
	Optional arguments are enclosed in square brackets [].

ABOUT MODULES

	Module objects may be placed in a list-type property on a user object, $user.modules
	
	New server commands can be added to a module object as opposed to $admin and $user.

	Administrators can set modules for all and/or individual users.

	If the module is not found in a user's .modules property, the verbs on it will not work for that user.

COMMANDS

	@open <host> <port>

		Initiate a connection and hold its output until @net is entered.
		Note: An object number pointing to this connection is stored in the .open_connection property of the
		user who entered it, and the user may only have one active connection at a time.

	@net [input-line]

		Without [input-line]: Display output from remote connection (if any).
		
		With [input-line]: Send [input-line] to the remote connection, then displays the resulting output (if any).

	@close

		Terminate an active connection and reset the user's .open_connection property to #-1.