framexmit/framesend.hh

#ifndef _GDS_FRAMESEND_H
#define _GDS_FRAMESEND_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 "framexmit/fxmittask.h"
#include "framexmit/fxmitmutex.hh"
#include "framexmit/framexmittypes.hh"

namespace framexmit {

   class frameSend {
      friend void xmitDaemonCallback (frameSend&);
   
   public:
      explicit frameSend (int maxBuffers = sndDefaultBuffers) 
      : sock (-1), seq (0), maxbuffers (maxBuffers) {
      }
   
      explicit frameSend (const char* addr, const char* interface = 0,
                        int port = frameXmitPort,
                        int maxBuffers = sndDefaultBuffers) 
      : sock (-1), seq (0), maxbuffers (maxBuffers) {
         open (addr, interface, port);
      }
   
      ~frameSend () {
         close();
      }
   
      bool open (const char* addr, const char* interface = 0, 
                int port = frameXmitPort);
   
      bool open (int port = frameXmitPort) {
         return open (0, 0, port);
      }
   
      void close ();
   
      bool send (char* data, int len, bool* inUse = 0, bool copy = false,
                unsigned int timestamp = 0, unsigned int duration = 0);
   
      int skipped () const {
         return skippedDataBuffers;
      }
   
      bool isUsed (bool& inUse) const {
         inUseMux.lock();
         bool u = inUse;
         inUseMux.unlock();
         return u;
      }
   
   private:
      int                       sock;
      bool                      multicast;
      struct sockaddr_in        name;
      unsigned int              seq;
      int                       maxbuffers;
      int                       skippedDataBuffers;
      mutable mutex             inUseMux;
   
      class buffer {
      public:
         buffer ();
         buffer (const buffer& buf);
         buffer (char* Data, int Len, unsigned int Seq, bool Own = false,
                bool* Used = 0, mutex* InUseMux = 0, 
                unsigned int Timestamp = 0, unsigned int Duration = 0);
         ~buffer();
         buffer& operator= (const buffer& buf);
      
         unsigned int   seq;
         mutable bool   own;
         char*          data;
         int            len;
         mutable bool*  used;
         mutex*         inUseMux;
         unsigned int   timestamp;
         unsigned int   duration;
         int            sofar;
      };
      static bool compSeqeuence (const buffer&, const retransmitpacket&);   
   
      std::deque<buffer>        buffers;
      int                       curbuf;
      framexmit::mutex          mux;
      bool send (buffer& data);
      friend  bool compSeqeuence (const buffer& b,      
                        const retransmitpacket& p);
      taskID_t                  daemon;
   
      bool putPackets (packet pkts[], int n);
      bool getRetransmitPacket (retransmitpacket& pkt);
      void xmitDaemon ();
   
      frameSend (const frameSend&);
      frameSend& operator= (const frameSend&);
   };

}

#endif // _GDS_FRAMESEND_H

---