tcpip::Socket Class Reference

#include <socket.h>

---

Detailed Description

Definition at line 77 of file socket.h.

Public Member Functions
void	accept () throw ( SocketException )
	Wait for a incoming connection to port_.
void	close ()
void	connect () throw ( SocketException )
	Connects to host_:port_.
bool	has_client_connection () const
bool	is_blocking () throw ()
int	port ()
std::vector< unsigned char >	receive (int bufSize=2048) throw ( SocketException )
bool	receiveExact (Storage &) throw ( SocketException )
void	send (const std::vector< unsigned char >) throw ( SocketException )
void	sendExact (const Storage &) throw ( SocketException )
void	set_blocking (bool) throw ( SocketException )
void	set_verbose (bool newVerbose)
	Socket (int port)
	Constructor that prepare for accepting a connection on given port.
	Socket (std::string host, int port)
	Constructor that prepare to connect to host:port.
bool	verbose ()
	~Socket ()
	Destructor.
Private Member Functions
bool	atoaddr (std::string, struct in_addr &addr)
void	BailOnSocketError (std::string) const throw ( SocketException )
bool	datawaiting (int sock) const throw ()
void	init ()
Private Attributes
bool	blocking_
std::string	host_
int	port_
int	server_socket_
int	socket_
bool	verbose_
Friends
class	Response

---

Constructor & Destructor Documentation

tcpip::Socket::Socket	(	std::string	host,
		int	port
	)

Constructor that prepare to connect to host:port.

Definition at line 70 of file socket.cpp.

References init(), and verbose_.

        : host_( host ),
        port_( port ),
        socket_(-1),
        server_socket_(-1),
        blocking_(true)
    {
        verbose_ = false;
        init();
    }

tcpip::Socket::Socket

(

int

port

)

Constructor that prepare for accepting a connection on given port.

Definition at line 83 of file socket.cpp.

References init(), and verbose_.

        : host_(""),
        port_( port ),
        socket_(-1),
        server_socket_(-1),
        blocking_(true)
    {
        verbose_ = false;
        init();
    }

tcpip::Socket::~Socket

(

)

Destructor.

Definition at line 114 of file socket.cpp.

References close(), server_socket_, and socket_.

    {
        // Close first an existing client connection ...
        close();
#ifdef WIN32
        instance_count_--;
#endif

        // ... then the server socket
        if( server_socket_ >= 0 )
        {
#ifdef WIN32
            ::closesocket( server_socket_ );
#else
			::close( server_socket_ );
#endif
            server_socket_ = -1;
        }

#ifdef WIN32
        if( server_socket_ == -1 && socket_ == -1 
            && init_windows_sockets_ && instance_count_ == 0 )
                WSACleanup();
                windows_sockets_initialized_ = false;
#endif
    }

---

Member Function Documentation

void tcpip::Socket::accept

(

)

throw ( SocketException )

Wait for a incoming connection to port_.

Definition at line 219 of file socket.cpp.

References BailOnSocketError(), blocking_, port_, server_socket_, set_blocking(), and socket_.

    {
        if( socket_ >= 0 )
            return;

        struct sockaddr_in client_addr;
#ifdef WIN32
        int addrlen = sizeof(client_addr);
#else
        socklen_t addrlen = sizeof(client_addr);
#endif

        if( server_socket_ < 0 )
        {
            struct sockaddr_in self;

            //Create the server socket
            server_socket_ = static_cast<int>(socket( AF_INET, SOCK_STREAM, 0 ));
            if( server_socket_ < 0 )
                BailOnSocketError("tcpip::Socket::accept() @ socket");
            
            //"Address already in use" error protection
            {
                int reuseaddr = 1;

                #ifdef WIN32
                    //setsockopt(server_socket_, SOL_SOCKET, SO_REUSEADDR, (const char*)&reuseaddr, sizeof(reuseaddr));
                    // No address reuse in Windows!!!
                #else
                    setsockopt(server_socket_, SOL_SOCKET, SO_REUSEADDR, &reuseaddr, sizeof(reuseaddr));
                #endif
            }

            // Initialize address/port structure
            memset(&self, 0, sizeof(self));
            self.sin_family = AF_INET;
            self.sin_port = htons(port_);
            self.sin_addr.s_addr = htonl(INADDR_ANY);

            // Assign a port number to the socket
            if ( bind(server_socket_, (struct sockaddr*)&self, sizeof(self)) != 0 )
                BailOnSocketError("tcpip::Socket::accept() Unable to create listening socket");


            // Make it a "listening socket"
            if ( listen(server_socket_, 10) == -1 )
                BailOnSocketError("tcpip::Socket::accept() Unable to listen on server socket");

            // Make the newly created socket blocking or not
            set_blocking(blocking_);
        }

        socket_ = static_cast<int>(::accept(server_socket_, (struct sockaddr*)&client_addr, &addrlen));

        if( socket_ >= 0 )
        {
            int x = 1;
            setsockopt(socket_, IPPROTO_TCP, TCP_NODELAY, (const char*)&x, sizeof(x));
        }
    }

bool tcpip::Socket::atoaddr	(	std::string	address,
		struct in_addr &	addr
	)			[private]

Definition at line 193 of file socket.cpp.

Referenced by connect().

    {
        struct hostent* host;
        struct in_addr saddr;

        // First try nnn.nnn.nnn.nnn form
        saddr.s_addr = inet_addr(address.c_str());
        if (saddr.s_addr != static_cast<unsigned int>(-1)) 
        {
            addr = saddr;
            return true;
        }

        host = gethostbyname(address.c_str());
        if( host ) {
            addr = *((struct in_addr*)host->h_addr_list[0]);
            return true;
        }

        return false;
    }

void tcpip::Socket::BailOnSocketError

(

std::string

context

)

const throw ( SocketException ) [private]

Definition at line 144 of file socket.cpp.

Referenced by accept(), connect(), datawaiting(), init(), receive(), receiveExact(), send(), and set_blocking().

    {
#ifdef WIN32
        int e = WSAGetLastError();
        std::string msg = GetWinsockErrorString( e );
#else
        std::string msg = strerror( errno );
#endif
        throw SocketException( context + ": " + msg );
    }

void tcpip::Socket::close

(

)

Definition at line 343 of file socket.cpp.

References socket_.

Referenced by testclient::TraCITestClient::close(), OutputDevice_Network::~OutputDevice_Network(), and ~Socket().

    {
        // Close client-connection 
        if( socket_ >= 0 )
        {
#ifdef WIN32
            ::closesocket( socket_ );
#else
			::close( socket_ );
#endif

            socket_ = -1;
        }
    }

void tcpip::Socket::connect

(

)

throw ( SocketException )

Connects to host_:port_.

Definition at line 312 of file socket.cpp.

References atoaddr(), BailOnSocketError(), host_, port_, and socket_.

Referenced by testclient::TraCITestClient::connect(), and receive().

    {
        in_addr addr;
        if( !atoaddr( host_.c_str(), addr) )
            BailOnSocketError("tcpip::Socket::connect() @ Invalid network address");

        sockaddr_in address;
        memset( (char*)&address, 0, sizeof(address) );
        address.sin_family = AF_INET;
        address.sin_port = htons( port_ );
        address.sin_addr.s_addr = addr.s_addr;

        socket_ = static_cast<int>(socket( PF_INET, SOCK_STREAM, 0 ));
        if( socket_ < 0 )
            BailOnSocketError("tcpip::Socket::connect() @ socket");

        if( ::connect( socket_, (sockaddr const*)&address, sizeof(address) ) < 0 )
            BailOnSocketError("tcpip::Socket::connect() @ connect");

        if( socket_ >= 0 )
        {
            int x = 1;
            setsockopt(socket_, IPPROTO_TCP, TCP_NODELAY, (const char*)&x, sizeof(x));
        }

    }

bool tcpip::Socket::datawaiting

(

int

sock

)

const throw () [private]

Definition at line 168 of file socket.cpp.

References BailOnSocketError().

Referenced by receive().

    {
        fd_set fds;
        FD_ZERO( &fds );
        FD_SET( sock, &fds );

        struct timeval tv;
        tv.tv_sec = 0;
        tv.tv_usec = 0;

        int r = select( sock+1, &fds, NULL, NULL, &tv);

        if (r < 0)
            BailOnSocketError("tcpip::Socket::datawaiting @ select");

        if( FD_ISSET( sock, &fds ) )
            return true;
        else
            return false;
    }

bool tcpip::Socket::has_client_connection

(

)

const

Definition at line 545 of file socket.cpp.

References socket_.

    {
        return socket_ >= 0;
    }

void tcpip::Socket::init

(

)

[private]

Definition at line 97 of file socket.cpp.

References BailOnSocketError().

Referenced by Socket().

    {
#ifdef WIN32
        instance_count_++;

        if( init_windows_sockets_ && !windows_sockets_initialized_ )
        {
            WSAData wsaData;
            if( WSAStartup(MAKEWORD(1, 1), &wsaData) != 0 )
                BailOnSocketError("Unable to init WSA Sockets");
            windows_sockets_initialized_ = true;
        }
#endif
    }

bool tcpip::Socket::is_blocking

(

)

throw ()

Definition at line 554 of file socket.cpp.

References blocking_.

    {
        return blocking_;
    }

int tcpip::Socket::port

(

)

Definition at line 159 of file socket.cpp.

References port_.

    {
        return port_;
    }

vector< unsigned char > tcpip::Socket::receive

(

int

bufSize = 2048

)

throw ( SocketException )

Definition at line 430 of file socket.cpp.

References BailOnSocketError(), connect(), datawaiting(), socket_, and verbose_.

    {
        vector<unsigned char> b;

        if( socket_ < 0 )
            connect();

        if( !datawaiting( socket_) )
            return b;

        unsigned char const * const buf = new unsigned char[bufSize];
        int a = recv( socket_, (char*)buf, bufSize, 0 );

        if( a <= 0 )
        {
            // BailOnSocketError definitely throws an exception so clear up heap
            delete[] buf;
            BailOnSocketError( "tcpip::Socket::receive() @ recv" );
        }

        b.resize(a);
        for(int i = 0; i < a; ++i)
        {
            b[i] = buf[i];
        }

        if (verbose_) 
        {
            cerr << "Rcvd "  << a <<  " bytes via tcpip::Socket: [";
            for(int i = 0; i < a; ++i)
            {
                cerr << " " << (int)b[i] << " ";
            }
            cerr << "]" << endl;
        }

        delete[] buf;
        return b;
    }

bool tcpip::Socket::receiveExact

(

Storage &

msg

)

throw ( SocketException )

Definition at line 476 of file socket.cpp.

References BailOnSocketError(), tcpip::Storage::readInt(), socket_, and verbose_.

Referenced by testclient::TraCITestClient::commandChangeLane(), testclient::TraCITestClient::commandChangeRoute(), testclient::TraCITestClient::commandChangeTarget(), testclient::TraCITestClient::commandClose(), testclient::TraCITestClient::commandDistanceRequest(), testclient::TraCITestClient::commandGetTLStatus(), testclient::TraCITestClient::commandGetVariable(), testclient::TraCITestClient::commandGetVariablePlus(), testclient::TraCITestClient::commandPositionConversion(), testclient::TraCITestClient::commandScenario(), testclient::TraCITestClient::commandSetMaximumSpeed(), testclient::TraCITestClient::commandSetValue(), testclient::TraCITestClient::commandSimulationStep(), testclient::TraCITestClient::commandSimulationStep2(), testclient::TraCITestClient::commandSlowDown(), testclient::TraCITestClient::commandStopNode(), and testclient::TraCITestClient::commandSubscribeVariable().

    {
        /* receive length of vector */
        unsigned char * const bufLength = new unsigned char[4];
        int bytesRead = 0;
        int readThisTime = 0;
        
        while (bytesRead<4)
        {
            readThisTime = recv( socket_, (char*)(bufLength + bytesRead), 4-bytesRead, 0 );

            if( readThisTime <= 0 )
            {
                // BailOnSocketError definitely throws an exception so clear up heap
                delete[] bufLength;
                BailOnSocketError( "tcpip::Socket::receive() @ recv" );
            }

            bytesRead += readThisTime;
        }
        Storage length_storage(bufLength,4);
        int NN = length_storage.readInt() - 4;

        /* receive vector */
        unsigned char * const buf = new unsigned char[NN];
        bytesRead = 0;
        readThisTime = 0;
        
        while (bytesRead<NN)
        {
            readThisTime = recv( socket_, (char*)(buf + bytesRead), NN-bytesRead, 0 );

            if( readThisTime <= 0 )
            {
                // BailOnSocketError definitely throws an exception so clear up heap
                delete[] bufLength;
                delete[] buf;
                BailOnSocketError( "tcpip::Socket::receive() @ recv" );
            }

            bytesRead += readThisTime;
        }
        msg.reset();
        msg.writePacket(buf, NN);
        
        if (verbose_)
        {
            cerr << "Rcvd Storage with "  << 4 + NN <<  " bytes via tcpip::Socket: [";
            for (int i=0; i < 4; ++i)
            {
                cerr << " " << (int)bufLength[i] << " ";
            }
            for (int i=0; i < NN; ++i)
            {
                cerr << " " << (int)buf[i] << " ";
            }
            cerr << "]" << endl;
        }

        delete[] buf;
        delete[] bufLength;
        return true;
    }

void tcpip::Socket::send

(

const std::vector< unsigned char >

b

)

throw ( SocketException )

Definition at line 361 of file socket.cpp.

References BailOnSocketError(), socket_, and verbose_.

Referenced by OutputDevice_Network::postWriteHook(), and sendExact().

    {
        if( socket_ < 0 ) return;

        size_t numbytes = b.size();
        unsigned char *const buf = new unsigned char[numbytes];

        for(size_t i = 0; i < numbytes; ++i)
        {
            buf[i] = b[i];
        }

        if (verbose_) 
        {
            cerr << "Send " << numbytes << " bytes via tcpip::Socket: [";
            for(size_t i = 0; i < numbytes; ++i)
            {
                buf[i] = b[i];
                cerr << " " << (int)b[i] << " ";
            }
            cerr << "]" << endl;
        }

        unsigned char const *buf_ptr = buf;
        while( numbytes > 0 )
        {
#ifdef WIN32
            int n = ::send( socket_, (const char*)buf_ptr, static_cast<int>(numbytes), 0 );
#else
            int n = ::send( socket_, buf_ptr, numbytes, 0 );
#endif
            if( n<0 )
            {
                // BailOnSocketError definitely throws an exception so clear up heap
                delete[] buf;
                BailOnSocketError( "send failed" );
            }

            numbytes -= n;
            buf_ptr += n;
        }

        delete[] buf;
    }

void tcpip::Socket::sendExact

(

const Storage &

b

)

throw ( SocketException )

Definition at line 413 of file socket.cpp.

References tcpip::Storage::begin(), tcpip::Storage::end(), send(), and tcpip::Storage::writeInt().

Referenced by testclient::TraCITestClient::commandChangeLane(), testclient::TraCITestClient::commandChangeRoute(), testclient::TraCITestClient::commandChangeTarget(), testclient::TraCITestClient::commandClose(), testclient::TraCITestClient::commandDistanceRequest(), testclient::TraCITestClient::commandGetTLStatus(), testclient::TraCITestClient::commandGetVariable(), testclient::TraCITestClient::commandGetVariablePlus(), testclient::TraCITestClient::commandPositionConversion(), testclient::TraCITestClient::commandScenario(), testclient::TraCITestClient::commandSetMaximumSpeed(), testclient::TraCITestClient::commandSetValue(), testclient::TraCITestClient::commandSimulationStep(), testclient::TraCITestClient::commandSimulationStep2(), testclient::TraCITestClient::commandSlowDown(), testclient::TraCITestClient::commandStopNode(), and testclient::TraCITestClient::commandSubscribeVariable().

    {
        int length = static_cast<int>(b.size());
        Storage length_storage;
        length_storage.writeInt(length + 4);
        vector<unsigned char> msg;
        msg.insert(msg.end(), length_storage.begin(), length_storage.end());
        msg.insert(msg.end(), b.begin(), b.end());
        send(msg);
    }

void tcpip::Socket::set_blocking

(

bool

blocking

)

throw ( SocketException )

Definition at line 284 of file socket.cpp.

References BailOnSocketError(), blocking_, and server_socket_.

Referenced by accept().

    {
        blocking_ = blocking;

        if( server_socket_ > 0 )
        {
#ifdef WIN32
            ULONG NonBlock = blocking_ ? 0 : 1;
            if (ioctlsocket(server_socket_, FIONBIO, &NonBlock) == SOCKET_ERROR)
                BailOnSocketError("tcpip::Socket::set_blocking() Unable to initialize non blocking I/O");
#else
            long arg = fcntl(server_socket_, F_GETFL, NULL);
            if (blocking_)
            {
                arg &= ~O_NONBLOCK;
            } else {
                arg |= O_NONBLOCK;
            }
            fcntl(server_socket_, F_SETFL, arg);
#endif
        }
    
    }

void tcpip::Socket::set_verbose

(

bool

newVerbose

)

[inline]

Definition at line 108 of file socket.h.

References verbose_.

{ verbose_ = newVerbose; }

bool tcpip::Socket::verbose

(

)

[inline]

Definition at line 107 of file socket.h.

References verbose_.

{ return verbose_; }

---

Friends And Related Function Documentation

friend class Response [friend]

Definition at line 79 of file socket.h.

---

Field Documentation

bool tcpip::Socket::blocking_ [private]

Definition at line 123 of file socket.h.

Referenced by accept(), is_blocking(), and set_blocking().

std::string tcpip::Socket::host_ [private]

Definition at line 119 of file socket.h.

Referenced by connect().

int tcpip::Socket::port_ [private]

Definition at line 120 of file socket.h.

Referenced by accept(), connect(), and port().

int tcpip::Socket::server_socket_ [private]

Definition at line 122 of file socket.h.

Referenced by accept(), set_blocking(), and ~Socket().

int tcpip::Socket::socket_ [private]

Definition at line 121 of file socket.h.

Referenced by accept(), close(), connect(), has_client_connection(), receive(), receiveExact(), send(), and ~Socket().

bool tcpip::Socket::verbose_ [private]

Definition at line 125 of file socket.h.

Referenced by receive(), receiveExact(), send(), set_verbose(), Socket(), and verbose().

---

The documentation for this class was generated from the following files:

• socket.h
• socket.cpp