framexmit/framerecv.hh

#ifndef _GDS_FRAMERECV_H
#define _GDS_FRAMERECV_H
/*----------------------------------------------------------------------*/
/*                                                                      */
/* Module Name: framexmit                                               */
/*                                                                      */
/* Module Description: API for broadcasting frames                      */
/*                     implements a reliable UDP/IP broadcast for       */
/*                     large data sets over high speed links            */
/*                                                                      */
/* Module Arguments: none                                               */
/*                                                                      */
/* Revision History:                                                    */
/* Rel   Date     Programmer    Comments                                */
/* 1.0   10Aug99  D. Sigg       First release                           */
/*                                                                      */
/* Documentation References:                                            */
/*      Man Pages: doc/index.html (use doc++)                           */
/*      References: none                                                */
/*                                                                      */
/* Author Information:                                                  */
/* Name          Telephone       Fax             e-mail                 */
/* Daniel Sigg   (509) 372-8132  (509) 372-8137  sigg_d@ligo.mit.edu    */
/*                                                                      */
/* Code Compilation and Runtime Specifications:                         */
/*      Code Compiled on: Ultra-Enterprise, Solaris 5.7                 */
/*      Compiler Used: egcs-1.1.2                                       */
/*      Runtime environment: sparc/solaris                              */
/*                                                                      */
/* Code Standards Conformance:                                          */
/*      Code Conforms to: LIGO standards.       OK                      */
/*                        Lint.                 TBD                     */
/*                        ANSI                  OK                      */
/*                        POSIX                 OK                      */
/*                                                                      */
/* Known Bugs, Limitations, Caveats:                                    */
/*                                                                      */
/*                                                                      */
/*                                                                      */
/*                      -------------------                             */
/*                                                                      */
/*                             LIGO                                     */
/*                                                                      */
/*        THE LASER INTERFEROMETER GRAVITATIONAL WAVE OBSERVATORY.      */
/*                                                                      */
/*                     (C) The LIGO Project, 1996.                      */
/*                                                                      */
/*                                                                      */
/* California Institute of Technology                                   */
/* LIGO Project MS 51-33                                                */
/* Pasadena CA 91125                                                    */
/*                                                                      */
/* Massachusetts Institute of Technology                                */
/* LIGO Project MS NW17-161                                             */
/* Cambridge MA 01239                                                   */
/*                                                                      */
/* LIGO Hanford Observatory                                             */
/* P.O. Box 1970 S9-02                                                  */
/* Richland WA 99352                                                    */
/*                                                                      */
/* LIGO Livingston Observatory                                          */
/* 19100 LIGO Lane Rd.                                                  */
/* Livingston, LA 70754                                                 */
/*                                                                      */
/*----------------------------------------------------------------------*/

// include files
#include <netinet/in.h>
#include <deque>
#include <string>
#include "framexmit/framexmittypes.hh"

namespace framexmit {

   class frameRecv {
   public:
   
      explicit frameRecv (int QoS = 1) 
      : sock (-1), qos (QoS), logison (false), maxlog (25) {
      }
   
      ~frameRecv () {
         close();
      }
   
      bool open (const char* mcast_addr, const char* interface = 0, 
                int port = frameXmitPort);
   
      bool open (int port = frameXmitPort) {
         return open (0, 0, port);
      }
   
      void close ();
   
      bool purge ();
   
      int receive (char*& data, int maxlen, 
                  unsigned int* sequence = 0,
                  unsigned int* timestamp = 0, 
                  unsigned int* duration = 0);
   
      const char* logmsg ();
   
      void clearlog ();
   
      void logging (bool set = true) {
         logison = set; }
   
      void setmaxlog (int max = 25) {
         maxlog = max; }
   
   private:
      int                       sock;
      bool                      multicast;
      ip_mreq                   group;
      unsigned int              seq;
      int                       qos;
      double                    retransmissionRate;
      bool                      first;
      unsigned int              oldseq;
      struct sockaddr_in        name;
      typedef std::deque<auto_pkt_ptr> packetlist;
      packetlist                pkts;
      bool                      logison;
      int                       maxlog;
      std::deque<std::string>   logs;
      std::string               logbuf;
   
      bool getPacket (bool block = true);
      bool putPacket (retransmitpacket& pkt);
      static long long calcDiff (const packetlist& pkts, 
                        unsigned int newseq);
   
      frameRecv (const frameRecv&);
      frameRecv& operator= (const frameRecv&);
   
      void addLog (const std::string& s);
      void addLog (const char* s);
      const char* copyLog ();
   
   };

}

#endif // _GDS_FRAMERECV_H

---