/home/toby/moos-ivp/MOOS-2375-Oct0611/Core/MOOSLIB/XPCSocket.h

Go to the documentation of this file.

//
//   MOOS - Mission Oriented Operating Suite
//
//   A suit of Applications and Libraries for Mobile Robotics Research
//   Copyright (C) 2001-2005 Massachusetts Institute of Technology and
//   Oxford University.
//
//   This software was written by Paul Newman at MIT 2001-2002 and Oxford
//   University 2003-2005. email: pnewman@robots.ox.ac.uk.
//
//   This file is part of a  MOOS CORE Component.
//
//   This program is free software; you can redistribute it and/or
//   modify it under the terms of the GNU General Public License as
//   published by the Free Software Foundation; either version 2 of the
//   License, or (at your option) any later version.
//
//   This program 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
//   General Public License for more details.
//
//   You should have received a copy of the GNU General Public License
//   along with this program; if not, write to the Free Software
//   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
//   02111-1307, USA.
//
//   The XPC classes in MOOS are modified versions of the source provided
//   in "Making UNIX and Windows NT Talk" by Mark Nadelson and Thomas Haga
//
#ifndef _XPCSocket
#define _XPCSocket

#include "XPCGetProtocol.h"
#include "XPCGetHostInfo.h"
#include <stdio.h>
//#include <string.h>

#ifdef UNIX
    #include <sys/socket.h>
    #include <unistd.h>
    #include <fcntl.h>
    #include <errno.h>
    #include <iostream>
    #include <sys/types.h>
    #include <sys/ioctl.h>
    #ifdef PLATFORM_LINUX
        #define FIONBIO 0x5421
    #endif
#elif _WIN32
    #include <winsock2.h>
    #include "windows.h"
    #include "winbase.h"
    #include "winnt.h"
    typedef int socklen_t;
#else
    #error "Looks like the build scripts didn't set the platform type"
#endif

class XPCSocket
{
protected:
    int iPort;        // Socket port number
    int iSocket;        // Socket file descriptor
    int iBlocking;        // Blocking flag
    char cBind;        // Binding flag
    double  m_dfLastRead;
    struct sockaddr_in clientAddress;    // Address of the client that sent data
public:
    void vSetRecieveTimeOut(int nTimeOut);
    void SetReadTime(double dfTime){m_dfLastRead = dfTime;};
    double GetReadTime(){return m_dfLastRead;};

    //returns integer number of last socket error
    static int iGetLastError();
    // Constructor.  Creates a socket given a protocol (UDP / TCP) and a port number
    XPCSocket(const char *_sProtocol, int _iPort);

    // Constructor.  Stores a socket file descriptor
    XPCSocket(int _iSocket) : iSocket(_iSocket) { };

    // Destructor.  Closes the socket
    virtual ~XPCSocket()
    {
        vCloseSocket();
    }

    // Closes the socket
    void vCloseSocket()
    {
        #ifdef    WINDOWS_NT
            closesocket(iSocket);
        #else
            close(iSocket);
        #endif
    }

    // The following member functions sets socket options on and off
    void vSetDebug(int _iToggle);
    void vSetBroadcast(int _iToggle);
    void vSetReuseAddr(int _iToggle);
    void vSetKeepAlive(int _iToggle);
    void vSetLinger(struct linger _lingerOption);
    void vSetSocketBlocking(int _iToggle);

    // Sets the size of the send and receive buffer
    void vSetSendBuf(int _iSendBufSize);
    void vSetRecieveBuf(int _iRecieveBufSize);

    // The following member functions retrieve socket option settings
    int iGetDebug();
    int  iGetBroadcast();
    int  iGetReuseAddr();
    int  iGetKeepAlive();
    void vGetLinger(struct linger &_lingerOption);
    int  iGetSendBuf();
    int  iGetRecieveBuf();
    int  iGetSocketBlocking() { return iBlocking; }

    // Returns the socket file descriptor
    int  iGetSocketFd() { return iSocket; }

    // Gets the system error
    char *sGetError()
    {
        #ifdef UNIX
            return strerror(errno);
        #elif _WIN32
            static char buf[10];
            sprintf(buf, "%d", WSAGetLastError());
            return buf;
        #endif
    }
};

#endif