Home

C-Bits Package Documentation

Project Page

---

               

---

Socket.h

Go to the documentation of this file.

/* ====================================================================
 *              The CBITS Software License, Version 1.0
 *
 *               Copyright (c) 2002-2003 Bruce Lowery
 *                       All rights reserved
 *
 * Redistribution and use of this software, in source and binary forms, 
 * with or without modification, are permitted provided that the above 
 * copyright notice, this paragraph, and the following paragraph are 
 * retained in each source code file.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 BRUCE LOWERY OR OTHER CONTRIBUTORS 
 * TO THE CBITS LIBRARY 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.
 * ====================================================================
 */
#ifndef __SOCKET_H__
#define __SOCKET_H__

// C++ Standard Library
#include <string>
#include <sstream>
#include <iostream>
#include <iomanip>

// C Standard Library
#include <string.h>
#include <stdio.h>
#include <errno.h>

// CBits Headers
#include <cbits/SocketException.h>
#include <cbits/Timing.h>
#include <cbits/CriticalSection.h>
#include <cbits/sockstreambuf.h>
#include <cbits/CriticalSection.h>
#include <cbits/ServerSocket.h>


#ifdef WIN32 
// ------ W I N D O W S ------

//
// Windows networking header

#include <winsock>
#include <cbits/wsa_strerror.h>

// 
// For building a DLL

#ifdef BUILD_DLL
#define EXPORT __declspec(dllexport)
#else
#define EXPORT
#endif


#else       
// ------ N O T   W I N D O W S ------

#define EXPORT

//
// Unix networking/timing headers

#include <sys/types.h>
#include <sys/time.h>
#include <sys/socket.h>
#include <sys/select.h>
#include <netdb.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <unistd.h>
#include <fcntl.h>

#endif


namespace cbits {

// Forward References
class SocketExcetion;


#ifdef WIN32   
// ------ W I N D O W S ------

//
// Errno handling for WINDOWS

#define ERRNO h_errno

//
// Differences from BSD Socket API

typedef SOCKET              socket_t;
#define CLOSE_SOCKET(s)     closesocket((s))
#define GET_SOCKET_ERROR()  WSAGetLastError()
#define STRERROR(a)         wsa_strerror(a)
#define SOCKET_IS_VALID(a)  ((a)==INVALID_SOCKET?false:true)
#define SOCKET_EINTR        WSAEINTR
#define SOCKET_EAGAIN       WSAEWOULDBLOCK
#define SOCKET_ECONNRESET   WSAECONNRESET

typedef long int            ssize_t;

#else
// ------ N O T   W I N D O W S ------

//
// Errno handling

#define ERRNO errno

//
// Wrap these because WINSOCK version is different

typedef int                 socket_t;
#define CLOSE_SOCKET(s)     ::close((s))
#define GET_SOCKET_ERROR()  errno
#define STRERROR(a)         strerror(a)
#define SOCKET_IS_VALID(a)  (0<(a)?true:false)
#define SOCKET_EINTR        EINTR
#define SOCKET_EAGAIN       EAGAIN
#define SOCKET_ECONNRESET   ECONNRESET


#endif

#include <cbits/portable_mutex.h>



class EXPORT Socket
{

public: // PUBLIC MEMBERS

    Socket
    ( 
        const std::string& host, 
        const int port,          
        const bool now=true      
    ) 
        throw(SocketException);


    Socket
    ( 
        const char *host, 
        const int port, 
        const bool now=true 
    ) 
        throw(SocketException);


    Socket( const int port, const bool now=true ) 
        throw(SocketException);


    virtual ~Socket();

    
    virtual void  connect()  throw(SocketException);


    virtual const ssize_t readLine
    ( 
        std::string& buffer,      
        const std::string& delim, 
        int * const error=0,      
        const long int msec=0     
    )
        throw( SocketException );


    virtual const ssize_t read
    ( 
        char * const buffer,  
        const int buflen,     
        int * const error=0,  
        const long msec=0 
    ) 
        throw( SocketException );


    virtual const ssize_t receive
    ( 
        char * const buffer, 
        const int buflen, 
        const long int msec=0, 
        int * const error=0 
    ) 
        throw( SocketException );


    virtual  const  ssize_t  write
    ( 
        const char * buffer, 
        const long buflen,   
        int * const error=0, 
        const long int msec=0
    )

        throw( SocketException );


    virtual  const  ssize_t  send
    ( 
        const char * buffer, 
        const long buflen, 
        const long int msec=0, 
        int * const error=0 
    )
        throw( SocketException );


    const  socket_t  getHandle()  const;


    std::iostream&  get_iostream()  throw(SocketException);


    static Socket* create
    ( 
        const socket_t s  
    );


    inline const struct sockaddr_in& get_addr() const { return _host; }


     virtual const  bool  isError()  const;


    inline const std::string& getError()   const  { return _errstr; }


    virtual const bool isReadable
    ( 
        long int * msec=0, 
        int * const error=0
    ) const;


    virtual const bool isWritable
    ( 
        long int * msec=0, 
        int * const error=0
    ) const;


    inline operator std::ostream&() { return get_iostream(); }


    inline operator std::istream&() { return get_iostream(); }


    virtual const bool set_blocking_on();


    virtual const bool set_blocking_off();


    virtual const int getSockOpt
    ( 
        const int level,   
        const int op_name, 
        char* buffer,      
        int* buflen        
    ) const;


    std::ostream* getLogger() const;


    std::ostream* getLocalLogger() const; 


    void  setLocalLogger
    ( 
        std::ostream* os  
    ) const;


    void closeLocalLogger() const;


    static std::ostream* getGlobalLogger();


    static void setGlobalLogger( std::ostream* os );


    static void  closeGlobalLogger();


    // FIXME Socket.h  make nested class 'DateTime' private.
    class DateTime {};


protected:  // PROTECTED MEMBERS

    Socket();


    const bool isAvailable
    ( 
        fd_set* rd,        
        fd_set* wr,        
        long int * msec=0, 
        int * error=0      
    ) const;


    socket_t            _sockfd;  
    struct sockaddr_in  _host;    
    int                 _port;    
    std::iostream*      _iostream;
    mutable bool        _error;   
    mutable std::string _errstr;  
    bool                _is_connected; 
    // FIXME Socket.h _is_bound should be replaced with _is_connected.
    bool                _is_bound; 

    mutable std::ostream*  _llogr;   
    static  std::ostream*  _glogr;   
private: // PRIVATE MEMBERS

    friend class ServerSocket; 
    // FIXME Socket.h  set_bound should set _is_connected instead of _is_bound.
    inline void set_bound( const bool val ) { _is_bound = val; }

    void invalid_host
    ( 
        const char * 
    ) const throw( SocketException );


    socket_t make_socket
    ( 
        const char* name,  
        const int port,    
        const bool now     
    )
        throw( SocketException );


    unsigned long resolve_name
    ( 
        const char* 
    );


    void bind_address
    ( 
        struct sockaddr_in* inout_address,  
        unsigned long in_IP,                
        const int in_port                   
    );


    void ignore_epipe
    ( 
        const bool  
    );


    mutable CriticalSection     _write_csect;


    mutable CriticalSection     _read_csect;


    mutable CriticalSection     _csect;


private:  // DISALLOWED

    Socket( const Socket& );           // NO COPYING
    Socket& operator=(const Socket&);  // NO ASSIGMNENT

};

}; /* END OF NAMESPACE cbits */


std::ostream& operator<<( std::ostream& os, const cbits::Socket::DateTime& dt );


#ifdef SOCKET_GET_THREADID
#undef SOCKET_GET_THREADID
#endif

#if defined(USE_PTHREADS)
#include <pthread.h>
#define SOCKET_GET_THREADID (unsigned long)pthread_self()
#endif

#if defined(WIN32)
#define SOCKET_GET_THREADID (unsigned long)GetCurrentThreadId()
#endif


#define  elog    *(this->getLogger())<<"ERROR "<<cbits::Socket::DateTime()<<" {"<<SOCKET_GET_THREADID<<"} "<<__FILE__<<" [line "<<__LINE__<<"]: "

#ifdef TRACEON

#define trace  \
    do \
    {\
         *(this->getLogger())<<"TRACE "<<cbits::Socket::DateTime<<" {"<<SOCKET_GET_THREADID<<"} "<<__FILE__<<" [line "<<__LINE__<<"]"<<std::endl; \
    }while(false)
#else
#define trace  \
    do \
    {\
        /*NOP*/ \
    }while(false)
#endif

#endif

/*
 * $Id: Socket.h,v 1.9 2002/10/16 22:32:44 brulow Exp $
 * 
 * History: (Add nothing manually below)
 * -----------------------------------------------------------------------
 *
 * $Log: Socket.h,v $
 * Revision 1.9  2002/10/16 22:32:44  brulow
 * Improve doc, misc
 *
 * Revision 1.8  2002/10/14 21:08:00  brulow
 * *** empty log message ***
 *
 * Revision 1.7  2002/10/11 20:29:09  brulow
 * Add unit tests for sockets, fix some errors in Socket classes.
 *
 * Revision 1.6  2002/10/09 22:43:03  brulow
 * Improve documentation
 *
 * Revision 1.5  2002/10/09 02:12:09  brulow
 * fix URL in mainpage doc section
 *
 * Revision 1.4  2002/10/09 02:02:26  brulow
 * Improve package documentation
 *
 * Revision 1.3  2002/09/27 22:04:16  brulow
 * Add history footer to all .h .cpp files
 *
 *
 */

---

Generated by

Hosted by