phServerSocket.h

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
    Phission : 
        Realtime Vision Processing System
    
    Copyright (C) 2003-2006 Philip D.S. Thoren (pthoren@cs.uml.edu)
    University of Massachusetts at Lowell,
    Laboratory for Artificial Intelligence and Robotics
    
    This file is part of Phission.

    Phission 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 of the License, or
    (at your option) any later version.

    Phission 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 Phission; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 ---------------------------------------------------------------------------*/
/* -------------------------------------------------------------------------- *
 * phServerSocket.h: C++ Wrapper class for server socket programming          *
 *                                                                            *
 * -------------------------------------------------------------------------- *
 * This code is mostly from the Phission code base.                           *
 * This code was originally coded by John R. Watson in the Fall of 2003-2006 and   *
 * added to Phission by myself. Since then I've added some necessary          *
 * functionality for use in a streaming JPEG/Image server/client for Phission.*
 * I'm using it here to further stretch/test it's functionality               *
 * -------------------------------------------------------------------------- */
#ifndef _PHSERVERSOCKET_H
#define _PHSERVERSOCKET_H

#include <phStandard.h>
#include <phSocket.h>

/* ---------------------------------------------------------------------- */
/* ------------------------------------------------------------------------ */
PHAPI(class) phServerSocket : protected phSocket
{
private:
    /* The number of pending client connections allowed on an
     * accepting socket */
    int m_backlog;
    
    phMutex m_accept_lock;

public:
    phServerSocket( int port = 0, int backlog = 1 );
    ~phServerSocket();    

    int copy( phObject *copyto_obj );
    int swap( phObject *obj );
   
    /* The following four methods allow thread safe access to the
     * phServerSocket's member variables */
    int setPort( int port );
    int getPort();
    
    /* Backlog is the number of pending client connections there
     * can be on a socket that we're performing accepts on */
    int setBackLog( int backlog );
    int getBackLog();
    
    /* Wrap the phSocket 'block' and 'wakeup' calls so we can 
     * keep the rest of the inherited phSocket methods protected */
    /* This sets whether we should block on socket calls */
    int setBlocking( int set_blocking = phBLOCK );

    /* Try to wake up a phServerSocket if it's blocking on something,
     * this isn't gauranteed to work */
    void wakeup();
   
    int isSockValid();

    /* listen -- create a socket and listen on port for connections */
    int listen( const int port = -1, const int backlog = -1 );
    
    /* accept -- accept a client connection */
    /* m_exit_trigger will preempt the accept loop and return */
    phSocket *accept();
    
    virtual int print_object( FILE *fd );
};

#endif /* _PHSERVERSOCKET_H */

Copyright (C) 2002 - 2007

Philip D.S. Thoren ( pthoren@users.sourceforge.net ) University Of Massachusetts at Lowell Robotics Lab

---