commands.h

Go to the documentation of this file.

#ifndef COMMANDS_H
#define COMMANDS_H

//
// Command action function prototypes, see commands.c for the implementation
//

// Common interactive client commands 

int cmd_quit   (char *, MsgType, char *); // quit the application
int cmd_ping   (char *, MsgType, char *); // ping (comm handshake request)
int cmd_pong   (char *, MsgType, char *); // pong (comm handshake acknowledge)
int cmd_info   (char *, MsgType, char *); // return client application info
int cmd_version(char *, MsgType, char *); // return version info
int cmd_verbose(char *, MsgType, char *); // toggle verbose mode
int cmd_debug  (char *, MsgType, char *); // toggle debug (superverbose) mode
int cmd_help   (char *, MsgType, char *); // show command help
int cmd_history(char *, MsgType, char *); // cli history utility
int cmd_status (char *, MsgType, char *); // client STATUS command

// Barcode reader commands

int cmd_read   (char *, MsgType, char *); // read a barcode
int cmd_send   (char *, MsgType, char *); // send a raw barcode reader command 
int cmd_query  (char *, MsgType, char *); // send a raw barcode reader query
int cmd_ports  (char *, MsgType, char *); // show current reader comm ports
int cmd_setto  (char *, MsgType, char *); // set/query reader comm timeout
int cmd_reset  (char *, MsgType, char *); // reset runtime params

// Application command/action structure

struct Commands {
  char *cmd;        

  int(* action)(char *args, MsgType msgtype, char *reply);  
}
cmdtab[] = {   
  {"read"    ,cmd_read    },
  {"send"    ,cmd_send    },
  {"query"   ,cmd_query   },
  {"ports"   ,cmd_ports   },
  {"status"  ,cmd_status  },
  {"timeout" ,cmd_setto   },
  {"reset"   ,cmd_reset   },
  {"quit"    ,cmd_quit    },
  {"info"    ,cmd_info    },
  {"verbose" ,cmd_verbose },
  {"version" ,cmd_version },
  {"debug"   ,cmd_debug   },
  {"help"    ,cmd_help    },
  {"?"       ,cmd_help    },  // ? is an alias for help
  {"history" ,cmd_history },
  {"ping"    ,cmd_ping    },
  {"pong"    ,cmd_pong    }
};

// Number of commands defined (so we don't have to count correctly)
  
int NumCommands = sizeof(cmdtab)/sizeof(struct Commands);  

// command function return codes

#define CMD_OK   0   
#define CMD_ERR -1   
#define CMD_NOOP 1   

#endif // COMMANDS_H

---