srv-hosts.h

Go to the documentation of this file.

/*
 * srv-hosts.h
 *
 * Copyright (C) 2009  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Manages host connections.
 */

#ifndef AESOP_SRV_HOSTS_H__
#define AESOP_SRV_HOSTS_H__

// includes --------------------------------------------------------------------
#include "aesop-base/aesop-base.h"
#include "crypto/crypto.h"
#include "netlib/netlib.h"
#include "netrq/netrq.h"
#include "xdrbuf/xdrbuf.h"


namespace aesop {


/// \ingroup aesop_srv
/*@{*/


/// \defgroup aesop_hosts Host and Connection Management
/*@{*/

typedef netlib::conn_id_t conn_id_t;


/// single struct that contains all (exposed) remote host state
struct host_rec_t {
        host_rec_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        mode = eHostMode_Invalid;
                        udpPort = 0;
                        udpConn = 0;
                        tcpConn = 0;
                        udpToken = 0;
                        lastUdpReceived = 0;
                        publicKey = NULL;
                        desKey = NULL;
                        outbuf = NULL;
                        netQueue = NULL;
                }
        bool isValid(void) const throw() {
                        // NOTE: can be valid without TCP connection!
                        return (eHostMode_Invalid != mode &&
                                udpConn &&
                                udpToken &&
                                publicKey &&
                                desKey &&
                                outbuf &&
                                netQueue);
                }

        // data fields
        eHostMode       mode;           // current view of this host
        int             udpPort;        // remote UDP listening port
        conn_id_t       udpConn;        // connection to remote UDP
        conn_id_t       tcpConn;        // connection to remote TCP
        long            udpToken;       // token we use to communicate
        dword_t         lastUdpReceived;// last client clock we saw
        smart_ptr<crypto::RSAPublicKey> publicKey; // client's public key
        smart_ptr<crypto::DESKey> desKey; // des key associated with client
        smart_ptr<xdrbuf::Output> outbuf; // output xdr buffer
        smart_ptr<netrq::Queue> netQueue; // network request queue
};


/// Object that helps the server manage host connections.
/// NOTE: (to implementers) all methods should be threadsafe!
class HostManager {
public:
        // helper classes ------------------------------------------------------
        struct iterator_t {
        private:
                byte_t          opaque[10 * sizeof(long)];
        };

        // virtual destructor --------------------------------------------------
        virtual ~HostManager(void) throw();

        // aesop::HostManager class interface methods --------------------------
        virtual void addHost(IN conn_id_t udpConnID,
                                IN long udpToken,       ///< client's UDP token
                                IN const char * publicKey) = 0;

        /// This is the most efficient lookup (by UDP connection ID)
        virtual bool getHostByUdpConnectionID(IN conn_id_t udpConnId,
                                OUT host_rec_t& hr) = 0;

        virtual bool getHostByTcpConnectionID(IN conn_id_t tcpConnId,
                                OUT host_rec_t& hr) = 0;

        virtual void updateHost(IN host_rec_t& hr) = 0;

        virtual bool removeHost(IN conn_id_t hostId) = 0;

        /// requests a new iterator.
        virtual void getIterator(OUT iterator_t& iterator) = 0;

        /// returns the host for this iteration, and increments iterator
        virtual bool getNextHost(IO iterator_t& iterator,
                                OUT host_rec_t& hr) = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<HostManager> create(IN int udpSize);
};



};      // aesop namespace

#endif  // AESOP_SRV_HOSTS_H__