S3FC project page

S3FC home page

---

               

---

s3_txport_base.h

Go to the documentation of this file.

/*
 * Stone Three Foundation Class (s3fc) provides a number of utility classes.
 * Copyright (C) 2001 by Stone Three Signal Processing (Pty) Ltd.
 *
 * Authored by Stone Three Signal Processing (Pty) Ltd.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * Please see the file 'COPYING' in the source root directory.
 */

#ifndef S3_TXPORT_BASE_H
#define S3_TXPORT_BASE_H

#include <string>
#include <list>
#include <s3fc/s3_fifo_queue.h>
#include <s3fc/s3_event.h>

typedef int s3_txport_client_id;

template<typename T_Data>
class s3_txport_data
{

   std::list<s3_txport_client_id> idl;

  public:
   T_Data data;

   s3_txport_data(const T_Data& a_data, s3_txport_client_id a_id) :
      data(a_data)
   {
      idl.push_back(a_id);
   }

   s3_txport_data(const T_Data& a_data,
        const std::list<s3_txport_client_id>& a_idl) :
      idl(a_idl), data(a_data)
   {}

   s3_txport_data() {};

   void erase_client_ids()
   {
      idl.clear();
   }

   void set_id(const std::list<s3_txport_client_id>& id_list)
   {
      idl = id_list;
   }

   void set_id(s3_txport_client_id id)
   {
      idl.clear();
      idl.push_back(id);
   }

   s3_txport_client_id get_id() const
   {
      if (idl.size() != 1)
      {
    throw s3_generic_exception("s3_txport_data::get_id()",
                "More than one ID in ID list");
      }
      return idl.front();
   }

   // Returns the list of clients
   std::list<s3_txport_client_id> get_id_list() const
   {
      return idl;
   }
};

struct s3_txport_event
{
   enum event_type
   {
      connect,
      disconnect,
      metadata,
      error,
      information,
      reject,
      null_event
   };
   event_type event;
   s3_txport_client_id id;
   std::string message;
   s3_txport_event(event_type e, s3_txport_client_id a_id,
         const std::string& m) :
      event(e), id(a_id), message(m) {};
   s3_txport_event() : event(null_event), id(0), message(""){};
};


template<class T_Data>
class s3_txport_base : public s3_event_dispatcher<s3_txport_event>
{

  public:

   virtual ~s3_txport_base() {}

   virtual s3_fifo_queue<s3_txport_data<T_Data> >& get_tx_queue() = 0;

   virtual s3_fifo_queue<s3_txport_data<T_Data> >& get_rx_queue() = 0;

   virtual std::list<s3_txport_client_id> get_client_id_list() const = 0;

   virtual void send_metadata(s3_txport_client_id id,
               const std::string& metadata) = 0;

   virtual bool is_connected_by_id(s3_txport_client_id id) = 0;

   virtual bool disconnect_by_id(s3_txport_client_id id) = 0;

   virtual void disconnect_all() = 0;

   virtual bool listening() const = 0;
};


#endif

---

Send comments to: s3fc@stonethree.com