Main Page | Data Structures | File List | Data Fields | Globals

commands.c File Reference

ISIS server command functions. More...

#include "isisserver.h"

Functions

int isisCommand (char *cmdStr, char *replyStr)
 Process an ISIS server command.
int serverInfo (char *replyStr)
 Report consise server status as an IMPv2-compliant message.
void printHelp ()
 Print a quick summary of ISIS server commands to the console.
void printInfo ()
 Report detailed server info on server console (stdout).
void portInfo (char *replyStr)
 Create a string with the server's serial port table info.


Detailed Description

ISIS server command functions.

These functions are used for processing ISIS server commands.

... more to come ...


Function Documentation

int isisCommand char *  cmdStr,
char *  replyStr
 

Process an ISIS server command.

Parameters:
cmdStr String with command and arguments to process.
replyStr String to hold any reply generated by cmdStr
Returns:
MSG_REPLY if command generates a reply message to the caller MSG_NOOP if command does not require a reply or an error occurred MSG_ECHO if the entire message, including address header, is to be echoed to stdout.
The individual command actions are encapsulated in this routine, except for serverInfo() - someday we'll do this in a less hacky fashion.

int serverInfo char *  replyStr  ) 
 

Report consise server status as an IMPv2-compliant message.

Parameters:
replyStr String to contain the server status message
Returns:
MSG_REPLY (never returns an error).
Creates an IMPv2-compliant string with a summary of the current server status. Meant to be sent back as a DONE: or STATUS: type message to the client who requested the info.

void printHelp void   ) 
 

Print a quick summary of ISIS server commands to the console.

Prints the current command list to the console intended as an aide-memoire, not a proper help utility. Don't expect much from it (besides, the command set is SMALL, that's the idea).

void printInfo void   ) 
 

Report detailed server info on server console (stdout).

printInfo() makes a detailed, formatted report of the current server status on stdout.

For generic, concise info services, see serverInfo().

void portInfo char *  replyStr  ) 
 

Create a string with the server's serial port table info.

Parameters:
replyStr String to hold the serial port table summary
Create a string with as summary of the current serial ports in IMPv2-compliant format suitable for transmission to an ISIS client.


Generated on Tue Apr 16 17:04:08 2013 for ISIS Server by  doxygen 1.3.9.1