isisserver.h

Go to the documentation of this file.

#ifndef ISISSERVER_H
#define ISISSERVER_H

//
// Main ISIS header file
//
// R. Pogge, OSU Astronomy Dept.
// pogge@astronomy.ohio-state.edu
// 2003 January 20
//
// Last modification: 2009 May 8 [v2.x]
//

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <errno.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <sys/times.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/file.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <time.h>
#include <termios.h>
#include <fcntl.h>
#include <ctype.h>

// In case the version and compilation data are not defined at
// compilation, put in some placeholders to prevent code barfing

#ifndef ISIS_VERSION
#define ISIS_VERSION "0.0"          
#endif

#ifndef ISIS_COMPDATE
#define ISIS_COMPDATE "0000-00-00"  
#endif

#ifndef ISIS_COMPTIME
#define ISIS_COMPTIME "00:00:00"    
#endif

#ifndef ISIS_CONFIG
#define ISIS_CONFIG  "/lhome/dts/Config/isis.ini"   
#endif

#ifndef ISIS_DCONFIG
#define ISIS_DCONFIG  "/lhome/dts/Config/isisd.ini"   
#endif

#ifndef ISIS_LOGS
#define ISIS_LOGS  "/lhome/Logs/ISIS/isis.log"   
#endif

// Various site-dependent but system-independent default values 

// These are for ISIS running at MDM

#define DEFAULT_LOCALHOST "IS"  
#define DEFAULT_ISISPORT  0  

//
// END of Site-Dependent Setup
//
// Touch the stuff below this at your own risk..
//
//--------------------------------------------------------------------------

// String sizes 

#define POSIX

#define ISIS_MSGSIZE      4096  
#define IMPv2_HOST_SIZE   9     
#define LONG_STR_SIZE     4096  
#define MED_STR_SIZE      256   
#define BIG_STR_SIZE      2048  
#define SHORT_STR_SIZE    32    

// Some useful flags 

#define isis_TRUE       1       
#define isis_FALSE      0       
#define NUL             '\0'    

// Pseudo Client Indices for the server and broadcast 

#define ISIS_SERVER   777       
#define BROADCAST     666       

// Message action flags 

#define MSG_NOOP    0  
#define MSG_REPLY   1  
#define MSG_FORWARD 2  
#define MSG_ECHO    3  

// Message erorr codes 

#define ERR_UNKNOWN_HOST  -1  
#define ERR_UNKNOWN_FD    -2  
#define ERR_HOSTS_FULL    -3  

//--------------------------------------------------------------------------
//
// ISIS server global system table structure 
//
// Parameters are loaded from the isis.ini file
//

extern struct server {
  char serverID[IMPv2_HOST_SIZE];     
  int  sockFD;                        
  int  sockPort;                      
  char sockAddr[INET6_ADDRSTRLEN];    
  char hostName[64];                  
  char localHost[64];                 
  char startTime[24];                 
  char userID[SHORT_STR_SIZE];        
  int  keepGoing;                     
  int  isVerbose;                     
  int  useCLI;                        
  int  doLogging;                     
  int  doStartup;                     
  int  doHandShaking;                 
  char utcDate[SHORT_STR_SIZE];       
  char utcTime[SHORT_STR_SIZE];       
  char dateTag[SHORT_STR_SIZE];       
  char lastDate[SHORT_STR_SIZE];      
  char exeFile[MED_STR_SIZE];         
  char iniFile[MED_STR_SIZE];         
  char logRoot[MED_STR_SIZE];         
  char logFile[MED_STR_SIZE];         
  int  logFD;                         
  int  logDate;                       
  int  numClients;                    
  int  numSerial;                     
  int  numPreset;                     
  char instID[MED_STR_SIZE];          
} isis;

// ISIS Start/Restart Flags 

#define NO_STARTUP   0  
#define COLD_START   1  
#define WARM_START   2  

// ISIS logging date conventions

#define UTCDATE      0  
#define OBSDAY       1  

//--------------------------------------------------------------------------
//
// ISIS Client Table
//
 
#define MAXCLIENTS 32  


extern struct clients {
  char ID[IMPv2_HOST_SIZE];     
  int  method;                  
  int  fd;                      
  long addr;                    
  int  port;                    
  double tstamp;                
} clientTab[MAXCLIENTS];

// Client transport method codes 

#define UNASSIGNED 0   
#define SERIAL     1   
#define SOCKET     2   

//--------------------------------------------------------------------------
//
// ISIS serial port table
//

#define MAXSERIAL 8  


extern struct serial {
  char devName[MED_STR_SIZE];  
  int  fd;                     
} ttyTab[MAXSERIAL];

//--------------------------------------------------------------------------
//
// ISIS preset UDP socket port table
//
// May define up to MAXPRESET UDP socket port targets to ping
// on startup or restart.  These are not put into the host table
// unless we get a response from one of the ports.
//

#define MAXPRESET   8  


extern struct udpPreset {
  char host[MED_STR_SIZE];  
  int  port;                
} udpTab[MAXPRESET];

//--------------------------------------------------------------------------
//
// Function prototypes 
//
 
// Server startup and shutdown 

int  openSocket(int );
void closeSocket(int );
int  loadConfig(char *);
void handShake(void);

// Client Host Table Functions 

void initHostTable();
int  updateHosts(char *, int, int, long, int);
int  removeHost(char *);
int  isKnownHost(char *);
void printHosts(char *);
void hostInfo(char *, char *);

// Serial I/O Utilties 

int  initSerialPorts(void);
int  getSerialInfo(int );
void portInfo(char *);

// I/O handlers 

void ttyHandler(char *line);
void socketHandler(int );
void serialHandler(int );
void sendMessage(int, char *);
void handleMessage(int, int, char *);
void broadcastMessage(int, char *);

// Command Utilities 

int  isisCommand(char *, char *);
int  serverInfo(char *);
void printInfo(void);
void printHelp(void);

// Runtime Logging Utilities 

void initLog(void);
int  logMessage(char *);

// Utilities 

void   getUTCTime(void);
char   *getFineTime(void);
char   *getDateTime(void);
double sysTimeStamp(void);
char   *noonDateTag(void);
void   getArg(char *, int, char *);
void   upperCase(char *);

#endif  // ISISSERVER_H

---