common/incoming.h

Go to the documentation of this file.

// -*- C++ -*-
//
// This is a side-class to Connection which is used solely for listening for
// incoming connections.  A Listener will call the get_incoming() method of
// the BiDirConn it was constructed to manage, and will take the returned
// Connections and invoke the ConnEventHandler on them. This ConnEventHandler
// class will perform whatever sort of initialization/cross-connection that
// is desired for the newly created [incoming] 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 __INCOMING_H
#define __INCOMING_H

#include <vector>

#include "connection.h"
#include "listener.h"
#include "bidirconn.h"

class ConnEventHandler {
public:
    // Construct an empty ConnEventHandler
    ConnEventHandler();
    // A special-case constructor for the common-case of "connect incoming
    // connections to this one other thing."
    ConnEventHandler(const Connection *other_side);
#define CONNECT_TO_ONE(p)   (ConnEventHandler((p)))

    void add_peer(const Connection *peer);

    void operator ()(Connection*);

private:
    // A list of Connections that need to be connected to the BiDirConn
    // that's accepted/created/incoming.
    std::vector<Connection*>    peers;
    typedef std::vector<Connection*>::iterator  peer_iterator;

};

class Incoming : protected Messageable
{
  public:
    Incoming(ListenerP l, ConnEventHandler ceh);
    ~Incoming();

    std::string         get_id(void) const;
        
  private:
    void                start_listening();

    static void         *listener_thread(void *);

    ListenerP           base;
    ConnEventHandler    handler;

    pthread_t                   tid_listener;
};

#endif  /* __INCOMING_H */

---