common/bidirconn.h

Go to the documentation of this file.

// -*- C++ -*-
// bidirconn.h - This package defines a bi-directional connection, from which
// subclasses can be created for different types of bi-dir connections.
//
// ***** BEGIN LICENSE BLOCK *****
// Version: MPL 1.1/GPL 2.0/LGPL 2.1
// 
// The contents of this file are subject to the Mozilla Public License
// Version 1.1 (the "License"); you may not use this file except in
// compliance with the License. You may obtain a copy of the License at
// http://www.mozilla.org/MPL/
// 
// Software distributed under the License is distributed on an "AS IS"
// basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
// the License for the specific language governing rights and limitations
// under the License.
// 
// The Original Code is the consmgr network/serial-line monitoring package.
// 
// The Initial Developer of the Original Code is Chris P. Ross.
// Portions created by the Initial Developer are Copyright (C) 2000-2008
// the Initial Developer.  All Rights Reserved.
// 
// Contributor(s):
// 
// Alternatively, the contents of this file may be used under the terms of
// either the GNU General Public License Version 2 or later (the "GPL"), or
// the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
// in which case the provisions of the GPL or the LGPL are applicable instead
// of those above. If you wish to allow use of your version of this file only
// under the terms of either the GPL or the LGPL, and not to allow others to
// use your version of this file under the terms of the MPL, indicate your
// decision by deleting the provisions above and replace them with the notice
// and other provisions required by the GPL or the LGPL. If you do not delete
// the provisions above, a recipient may use your version of this file under
// the terms of any one of the MPL, the GPL or the LGPL.
// 
// ***** END LICENSE BLOCK *****

#ifndef __BIDIRCONN_H
#define __BIDIRCONN_H

extern "C" {
#include <pthread.h>
#include <string.h>
}

#include <deque>
#include <set>
#include <map>
#include <functional>

#include <string>

#include "messager.h"
#include "outlet.h"
#include "connlist.h"
#include "protocol.h"

class BiDirConn : public Outlet, public Messager {
  public:
    BiDirConn(ConnectorP&);
    virtual ~BiDirConn() throw();

    void                add_encoder(Encoder*);

    virtual std::string class_name(void) const { return("BiDirConn"); };
    virtual std::string get_id(void) const;
    
  protected:
    void                start_engine(void);

  private:
    static void         *reader_thread(void *);
    void                *reader(void);

    pthread_t           tid_reader;

    // XXX - Should we have a wrapper class for this as well, to protect it
    // with a mutex?
    std::set<Encoder*>  encoders;

  protected:
    virtual void        stop_engine(void);

#if SHOULD_NOT_BE_HERE
    void                disconnect(void);
#endif

    /* XXX - This could be a MessageP, but as it's only looked at */
    /* and returned, I can just pass the Data*, right? */
    virtual void        process_data(Data*);

#if 0
    void                send_data_to_recipients(Blob *);
#endif
};


//
// Misc functions that exist mostly so that ConnectionList::mutating_for_each()
// can call their operator()'s...
//

class invoke_queue_data {
public:
    invoke_queue_data(MessageP &data) : m(data) {
        if (dynamic_cast<Data*>(MessageP::GetPointer(data)) == NULL)
            throw CMUnsupported("Cannot queue a non-data Message");
    }
    void operator()(Outlet *o) const {
        o->queue_data(const_cast<MessageP&>(m));
    }
private:
    MessageP    m;
};

#endif  /* __BIDIRCONN_H */

---