common/connection.h

Go to the documentation of this file.

// vim:ts=8 sts=4 sw=4

// ***** 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 __CONNECTION_H
#define __CONNECTION_H

#include "messageable.h"
#include "messager.h"
#include "connector.h"

class Connection : public Messageable
{
  public:
    Connection(ConnectorP&);
    virtual ~Connection() throw();

  private:
    static void         *manager_thread(void*);

    //
    // Useful methods
    //

  private:
    void                manager(void);

#if SHOULD_NOT_BE_HERE

    void                initiate_connection(void);
#endif
  public:       // Perhaps shutdown() should be a pure virtual of Messageable?
    void                shutdown(void);


    //
    // Virtual methods for functionality that needs to be implemented
    // in a connection-type-dependant way.
    //

  protected:
    virtual void        start_engine(void) = 0;
    virtual void        stop_engine(void) = 0;


  public:
    //
    // Inquires
    //
#if MAY_NOT_WANT_THIS
    bool                connected(void);
#endif
    virtual std::string class_name(void) const { return "Connection"; }
    virtual std::string get_id(void) const = 0;

    //
    // Data members
    //

  protected:
    ConnectorP          base;           

    void                note_disconnect(void);

    bool                please_exit;

  private:
    pthread_mutex_t     mutex;

#if MAY_NOT_WANT_THIS
    pthread_cond_t      state_change;   // Signal change in connection state
    bool                conn_state;     
#endif
        
    pthread_t           tid_manager;
};

// This is a class who's function operator can be passed to a for_each
// call.  It will remove the given Messageable from the recipient list
// of all Connections.
class invalidate_messageable {
 public:
    invalidate_messageable(Messageable *m) : recipient(m) {}
    void operator()(const Connection *conn) const {
        // This dynamic cast will only produce a non-NULL pointer
        // if only conn is a Messager.  If it's some non-messaging
        // other subclass of Connection, it will return NULL.
        Messager        *sender = const_cast<Messager*>(
                                    dynamic_cast<const Messager*>(conn));
        if (sender)
            sender->del_recipient(recipient);
    }
 private:
    Messageable *recipient;
};

#endif  /* __CONNECTION_H */

---