WJAM 262

New User? Try this.

1. Go to the client directory
2. Run ./client.py and you will get a usage hint. As per the usage hint, use rest to try our Restful API Server and wire to try our Custom Wire Protocol. (Note: if this is your first connection, you must use the register keyword to register a new user).
3. Once you've run the client.py interpreter, you can press enter to get a list of useful commands. Message away!

High Level Code Overview

Client

The client folder contains the code that will run in the clients for this software.

Description of Files

• client.py: This is the main driver program for the client. The command line arguments to this program determine which api (Rest/WireProtocol) to use, and it registers the appropriate handler and waits for an instruction.
• basehandler.py: This is the abstract client handler class, and it implements some shared functions between the Rest and WireProtocol handler. RestHandler and WireHandler inherit this class, and implement the parsing system for the various commands (getting users, making groups, getting/sending messages, etc.)
• resthandler.py: The REST-specific implementation of BaseHandler.
• wirehandler.py: The WireProtocol-specific implementation of BaseHandler.

Server

The files in the top-level directory contain the server code

• server.py: This is the main driver program for the server. This loads the appropriate transfer protocol and starts listening for requests.
• requestprocessor.py: This is a protocol-agnostic backend, which contains the key data-structures. server.py instantiates a RequestProcessor, which takes protocol-agnostic internal request objects, and returns the appropriate responses, while also storing the information for the system, like the users, groups, messages, etc.
• RestAPIStub.py: This Stub contains the information needed to encode/decode requests and responses for the REST API. Decode converts the REST Request into the backend internal request that that RequestProcessor can handle.
• WireProtocolStub.py: This Stub contains the information needed to encode/decode requests and responses for the WireProtocol API. Decode converts the WireProtocol information into the backend internal request that that RequestProcessor can handle.