osg::Socket Class Reference
[Network]

Abstract network socket handler. More...

#include <OSGSocket.h>

Inheritance diagram for osg::Socket:

List of all members.

Public Member Functions
Constructors
	Socket (void)
	Socket (const Socket &source)
Destructor
virtual	~Socket ()
open, close, connect
virtual void	open (void)=0
virtual void	close (void)=0
void	bind (const SocketAddress &address=SocketAddress(SocketAddress::ANY))
void	listen (int maxPending=10)
void	connect (const SocketAddress &address)
read, write
int	recv (void *buf, int size)
int	recvAvailable (void *buf, int size)
int	recv (NetworkMessage &msg)
int	peek (void *buf, int size)
int	send (const void *buf, int size)
int	send (NetworkMessage &msg)
state access
void	setReusePort (bool value)
void	setBlocking (bool value)
SocketAddress	getAddress (void)
void	setReadBufferSize (int size)
void	setWriteBufferSize (int size)
int	getReadBufferSize (void)
int	getWriteBufferSize (void)
int	getAvailable (void)
bool	waitReadable (double duration)
bool	waitWritable (double duration)
Assignment
const Socket &	operator= (const Socket &source)
Static Public Member Functions
Error information
static int	getError (void)
static int	getHostError (void)
static std::string	getErrorStr (void)
static std::string	getHostErrorStr (void)
Protected Types
typedef void	SocketOptT
typedef socklen_t	SocketLenT
Protected Attributes
member
int	_sd
Static Private Attributes
static member
static int	initialized = 0
Friends
class	SocketSelection

---

Detailed Description

Socket baseclass. The Socket class wraps a socket descriptor. This class has no additional state variables. It is only h handle to the underlaying descriptor. Class createion and destruction has no influence to any descriptor. Use open to assign a descriptor and close to remove it from the system. If this class is copied, then there are to classes which uses the same descriptor. This is ok until you call close for one of this classes. One purpose of this implementation is to hide the differences between Windows and Unix sockets. Calls to this class should behave equally on all systems. As a result, some methods will not work as an experienced Windows ore Unix programmer maight expect. Please refere to the function docu to get details about this.

Definition at line 53 of file OSGSocket.h.

---

Member Typedef Documentation

typedef void osg::Socket::SocketOptT [protected]

Socket option type. Used to hide the different interface implementations

Definition at line 139 of file OSGSocket.h.

typedef socklen_t osg::Socket::SocketLenT [protected]

Socket length type. Used to hide the different interface implementations

Definition at line 146 of file OSGSocket.h.

---

Constructor & Destructor Documentation

Socket::Socket

(

void

)

Create a new Socket class. A valid socket descriptor will be assigned by calling open on a derived Socket class e.g. StreamSocket or DgramSocket. On Windows WSAStartup is called by the first socket createn.

Definition at line 108 of file OSGSocket.cpp.

References initialized.

                  :
    _sd(-1)
{
    if(!initialized)
    {
        initialized=1;
#ifdef WIN32
        WSADATA wsaData;
        
        WORD wVersionRequested = MAKEWORD( 2, 2 ); 
        if(WSAStartup( wVersionRequested, &wsaData )!=0)
        {
            throw SocketError("WSAStartup()");
        }
#endif
    }
}

Socket::Socket

(

const Socket &

source

)

Copy constructor

Definition at line 128 of file OSGSocket.cpp.

                                  :
    _sd(source._sd)
{
}

Socket::~Socket

(

)

[virtual]

Destructor. The Socket class is only a descriptor to the socket. By destruction of this class, the socket remains open.

Definition at line 136 of file OSGSocket.cpp.

{
}

---

Member Function Documentation

virtual void osg::Socket::open

(

void

)

[pure virtual]

Implemented in osg::DgramSocket, and osg::StreamSocket.

virtual void osg::Socket::close

(

void

)

[pure virtual]

Implemented in osg::DgramSocket, and osg::StreamSocket.

void Socket::bind

(

const SocketAddress &

address = SocketAddress(SocketAddress::ANY)

)

Bind a socket to a given SocketAddress. It is possible to bind a Socket to a special network interface ore to all availabel interfaces.

    sock.bind(AnySocketAddress(23344));           Bind Socket to port 23344 
    sock.bind(Address("123.223.112.33",0);  Bind to the given adapter
    sock.bind(AnySocketAddress(0));               Bind to a free port      
    port = sock.getAddress().getPort();     Get bound port
    

Definition at line 153 of file OSGSocket.cpp.

References _sd, getError(), osg::SocketAddress::getSockAddr(), and osg::SocketAddress::getSockAddrSize().

Referenced by osg::ClusterServer::acceptClient(), osg::PointSockConnection::bind(), osg::GroupSockConnection::bind(), osg::GroupMCastConnection::GroupMCastConnection(), osg::PointSockPipeline::initialize(), and osg::PointMCastConnection::initialize().

{
    SocketAddress result=address;
    
    if( ::bind(_sd,
               result.getSockAddr(),
               result.getSockAddrSize()) < 0)
    {
        if(getError() ==
#if defined WIN32
            WSAEADDRINUSE 
#else
            EADDRINUSE
#endif
        )
        {
            throw SocketInUse("bind()");
        }
        else
        {
            throw SocketError("bind()");
        }
    }
}

void Socket::listen

(

int

maxPending = 10

)

Set queue length for incomming connection requests

Definition at line 180 of file OSGSocket.cpp.

References _sd.

Referenced by osg::PointSockConnection::bind(), osg::GroupSockConnection::bind(), and osg::PointSockPipeline::initialize().

{
    if(::listen(_sd,maxPending)<0)
    {
        throw SocketError("listen()");
    }
}

void Socket::connect

(

const SocketAddress &

address

)

Connect to the given address. After connect, all send data will be transfered to the address.

Definition at line 191 of file OSGSocket.cpp.

References _sd, osg::SocketAddress::getSockAddr(), and osg::SocketAddress::getSockAddrSize().

Referenced by osg::GroupSockConnection::connectSocket(), osg::PointSockPipeline::initialize(), and osg::GroupSockPipeline::initialize().

{
    if( ::connect(_sd,
                  address.getSockAddr(),
                  address.getSockAddrSize()) )
    {
        throw SocketError("connect()");
    }
}

int Socket::recv	(	void *	buf,
		int	size
	)

Read size bytes into the buffer. Wait until size Bytes are available On Dgram sockets data maight be lossed, if size is smaller then the incomming package. This situation will not be treated as an error.

See also:

recvAvailable recvFrom

Definition at line 209 of file OSGSocket.cpp.

References _sd, and getError().

Referenced by osg::PointSockPipeline::initialize(), osg::PointMCastConnection::initialize(), peek(), osg::PointSockPipeline::read(), osg::PointSockConnection::read(), osg::PointSockPipeline::readBuffer(), osg::PointSockConnection::readBuffer(), recv(), recvAvailable(), osg::PointMCastConnection::recvQueue(), and osg::PointSockConnection::wait().

{
    int readSize;
    int pos=0;

    while(size)
    {
        readSize=::recv(_sd,((char*)buf) + pos,size,0);
        if(readSize < 0)
        {
#if defined WIN32
            if(getError() == WSAECONNRESET)
            {
                throw SocketConnReset("recv");
            }
            if(getError() == WSAEMSGSIZE)
            {
                readSize=size;
            }
            else
#endif
            throw SocketError("recv()");
        }
        if(readSize == 0)
        {
            return 0;
        }
        size-=readSize;
        pos +=readSize;
    }
    return pos;
}

int Socket::recvAvailable	(	void *	buf,
		int	size
	)

Read the data from the in buffer to a maximun length of size. don't wait until size bytes are available.

See also:

recv

Definition at line 246 of file OSGSocket.cpp.

References _sd, getError(), and recv().

{
    int len;

#ifndef WIN32
    do
    {
#endif
        len=::recv(_sd,(char*)buf,size,0);
#ifndef WIN32
    } 
    while(len < 0 && errno == EAGAIN);
#endif
    if(len==-1)
    {
#if defined WIN32
        switch(getError())
        {
        case WSAECONNRESET:
            throw SocketConnReset("recvAvailable()");
            break;
        case WSAEMSGSIZE:
            len=size;
            break;
        default:
            throw SocketError("recv()");
        }
#else
        throw SocketError("recv()");
#endif
    }
    return len;
}

int Socket::recv

(

NetworkMessage &

msg

)

Like recv, but buffer and size is taken from the NetworkMessage

See also:

recv

Definition at line 283 of file OSGSocket.cpp.

References osg::NetworkMessage::getBuffer(), osg::NetworkMessage::getSize(), osg::osgntohl(), peek(), recv(), osg::NetworkMessage::setSize(), and osg::NetworkMessage::Header::size.

{
    NetworkMessage::Header hdr;
    peek(&hdr,sizeof(hdr));
    msg.setSize(osgntohl(hdr.size));
    return recv(msg.getBuffer(),msg.getSize());
}

int Socket::peek	(	void *	buf,
		int	size
	)

Read size bytes into the buffer. Wait until size Bytes are available On Dgram sockets data maight be lossed, if size is smaller then the incomming package. This situation will not be treated as an error. The read bytes will not be removed from the in buffer. A call to recv after peek will result in the same data.

See also:

recv recvAvailable

Definition at line 298 of file OSGSocket.cpp.

References _sd, getError(), and recv().

Referenced by recv(), and osg::DgramSocket::recvFrom().

{
    int readSize;
    int pos=0;

    do
    {
        readSize=::recv(_sd,((char*)buf)+pos,size,MSG_PEEK);
        if(readSize<0)
        {
#if defined WIN32
            if(getError() == WSAECONNRESET)
            {
                throw SocketConnReset("peek");
            }
            if(getError() == WSAEMSGSIZE)
            {
                readSize=size;
            }
            else
#endif
                throw SocketError("peek");
        }
        if(readSize == 0)
        {
            return 0;
        }
    }
    while(readSize != size);
    return readSize;
}

int Socket::send	(	const void *	buf,
		int	size
	)

Write size bytes to the socket. This method maight block, if the output buffer is full.

Definition at line 333 of file OSGSocket.cpp.

References _sd.

Referenced by osg::PointSockPipeline::initialize(), osg::PointMCastConnection::initialize(), osg::PointSockPipeline::read(), osg::PointSockPipeline::readBuffer(), send(), osg::PointSockConnection::signal(), osg::PointSockConnection::write(), osg::GroupSockPipeline::write(), osg::PointSockConnection::writeBuffer(), and osg::GroupSockPipeline::writeBuffer().

{
    int writeSize;
    int pos=0;
    while(size)
    {
#if defined(WIN32) && defined(MSG_NOSIGNAL)
        writeSize=::send(_sd,((const char*)buf)+pos,size,MSG_NOSIGNAL);
#else
        writeSize=::send(_sd,((const char*)buf)+pos,size,0);
#endif
        if(writeSize == -1)
        {
            throw SocketError("send()");
        }
        if(writeSize == 0)
        {
            return 0;
        }
        size-=writeSize;
        pos+=writeSize;
    }
    return pos;
}

int Socket::send

(

NetworkMessage &

msg

)

Like send, but buffer and size is taken from the NetworkMessage

See also:

send

Definition at line 361 of file OSGSocket.cpp.

References osg::NetworkMessage::getBuffer(), osg::NetworkMessage::getHeader(), osg::NetworkMessage::getSize(), osg::osghtonl(), send(), and osg::NetworkMessage::Header::size.

{
    NetworkMessage::Header &hdr=msg.getHeader();
    hdr.size=osghtonl(msg.getSize());
    return send(msg.getBuffer(),msg.getSize());
}

void Socket::setReusePort

(

bool

value

)

Enable, disable reuse port behavior If reuse port is true, then more then on process or thread is able to bind to the same port. This makes sense for multicast or braodcast sockets. For StreamSockets this feature can be used to avoid the Socket in use message on not propperly closed ports.

Definition at line 377 of file OSGSocket.cpp.

References _sd.

Referenced by osg::ClusterServer::acceptClient(), osg::PointSockConnection::bind(), osg::GroupSockConnection::bind(), osg::GroupSockConnection::GroupSockConnection(), osg::PointMCastConnection::initialize(), osg::PointMCastConnection::PointMCastConnection(), and osg::PointSockConnection::PointSockConnection().

{
    int v=(int)value;
#ifdef SO_REUSEPORT
    ::setsockopt(_sd,SOL_SOCKET,SO_REUSEPORT,(SocketOptT*)&v,sizeof(v));
#endif
    ::setsockopt(_sd,SOL_SOCKET,SO_REUSEADDR,(SocketOptT*)&v,sizeof(v));
}

void Socket::setBlocking

(

bool

value

)

By default all recv, send, accept calls will block until the executeion is finished. This behavior can be swithed off bei setting blocking to false. This will lead to a more difficult programming. An easier way to get non blocking behavior is to use SocketSelections or waitReadable, waitWritable. These methods provide a timeout for waiting.

See also:

Socket::waitReadable Socket::waitWritable SocketSelection

Definition at line 394 of file OSGSocket.cpp.

References _sd.

{
#ifndef WIN32
    int val=0;
    
    if(value==false)
        val=O_NDELAY;
    if (fcntl(_sd, F_GETFL, &val) < 0) 
    {
        throw SocketError("fcntl()");
    }    
    val|=O_NDELAY;
    if(value)
    {
        val^=O_NDELAY;
    }
    if (fcntl(_sd, F_SETFL, val) < 0) 
    {
        throw SocketError("fcntl()");
    }    
#else
    u_long ulVal = !value;
    if( (ioctlsocket(_sd, FIONBIO, &ulVal)) != 0) 
    {
        throw SocketError("ioctlsocket()");
    }    
#endif
}

SocketAddress Socket::getAddress

(

void

)

Get bound SocketAddress

See also:

SocketAddress

Definition at line 426 of file OSGSocket.cpp.

References _sd, osg::SocketAddress::getSockAddr(), and osg::SocketAddress::getSockAddrSize().

Referenced by osg::PointSockConnection::bind(), osg::GroupSockConnection::bind(), osg::PointSockPipeline::initialize(), osg::PointMCastConnection::initialize(), and osg::GroupMCastConnection::initialize().

{
    SocketAddress result;
    SocketLenT len;

    len=result.getSockAddrSize();
    if( ::getsockname(_sd,result.getSockAddr(),&len) < 0)
    {
        throw SocketError("getsockname()");
    }
    return result;
}

void Socket::setReadBufferSize

(

int

size

)

Set the internal read buffer size

See also:

Socket::getReadBufferSize

Definition at line 442 of file OSGSocket.cpp.

References _sd.

Referenced by osg::GroupSockConnection::acceptSocket(), osg::GroupSockConnection::connectSocket(), osg::GroupMCastConnection::GroupMCastConnection(), and osg::PointMCastConnection::initialize().

{
    int v=(int)size;
    ::setsockopt(_sd,SOL_SOCKET,SO_RCVBUF,(SocketOptT*)&v,sizeof(v));
}

void Socket::setWriteBufferSize

(

int

size

)

Set the internal write buffer size

See also:

Socket::getWriteBufferSize

Definition at line 451 of file OSGSocket.cpp.

References _sd.

Referenced by osg::GroupSockConnection::acceptSocket(), and osg::GroupSockConnection::connectSocket().

{
    int v=(int)size;
    ::setsockopt(_sd,SOL_SOCKET,SO_SNDBUF,(SocketOptT*)&v,sizeof(v));
}

int Socket::getReadBufferSize

(

void

)

Get internal read buffer size

See also:

Socket::setReadBufferSize

Definition at line 460 of file OSGSocket.cpp.

References _sd.

Referenced by osg::GroupMCastConnection::GroupMCastConnection().

{
    int v;
    SocketLenT len=sizeof(v);
    ::getsockopt(_sd,SOL_SOCKET,SO_RCVBUF,(SocketOptT*)&v,&len);
    return v;
}

int Socket::getWriteBufferSize

(

void

)

Get internal write buffer size

See also:

Socket::setWriteBufferSize

Definition at line 471 of file OSGSocket.cpp.

References _sd.

{
    int v;
    SocketLenT len=sizeof(v);
    ::getsockopt(_sd,SOL_SOCKET,SO_SNDBUF,(SocketOptT*)&v,&len);
    return v;
}

int Socket::getAvailable

(

void

)

Get number of bytes in the internal read buffer

Definition at line 481 of file OSGSocket.cpp.

References _sd.

{
#ifndef WIN32
    int value;
    if(::ioctl(_sd, FIONREAD, &value)<0)
    {    
        throw SocketError("ioctl()");
    }
    return value;
#else
    u_long ulVal;
    if( (ioctlsocket(_sd, FIONREAD, &ulVal)) != 0) 
    {    
        throw SocketError("ioctlsocket()");
    }
    return (int)ulVal;
#endif
}

bool Socket::waitReadable

(

double

duration

)

Wait until recv or accept will not block. True is returned if data is available.

Definition at line 503 of file OSGSocket.cpp.

References osg::SocketSelection::select(), and osg::SocketSelection::setRead().

Referenced by osg::ClusterServer::acceptClient(), osg::GroupSockConnection::acceptSocket(), osg::ClusterWindow::init(), osg::PointMCastConnection::recvQueue(), osg::PointSockPipeline::selectChannel(), osg::PointSockConnection::selectChannel(), osg::PointMCastConnection::selectChannel(), osg::GroupMCastConnection::sendQueue(), and osg::PointSockConnection::wait().

{
    SocketSelection selection;
    selection.setRead(*this);
    if(selection.select(duration)==1)
        return true;
    else
        return false;
}

bool Socket::waitWritable

(

double

duration

)

Wait until send will not block for the given duration. True is returned if the next send will not block.

Definition at line 516 of file OSGSocket.cpp.

References osg::SocketSelection::select(), and osg::SocketSelection::setWrite().

{
    SocketSelection selection;
    selection.setWrite(*this);
    if(selection.select(duration)==1)
        return true;
    else
        return false;
}

const Socket & Socket::operator=

(

const Socket &

source

)

assignment

Definition at line 528 of file OSGSocket.cpp.

References _sd.

{
    _sd=source._sd;
    return *this;
}

int Socket::getError

(

void

)

[static]

Get last occured error

Definition at line 539 of file OSGSocket.cpp.

Referenced by bind(), getErrorStr(), peek(), osg::DgramSocket::peekFrom(), recv(), recvAvailable(), osg::DgramSocket::recvFrom(), and osg::SocketError::SocketError().

{
#ifdef WIN32
    return WSAGetLastError();
#else
    return errno;
#endif
}

int Socket::getHostError

(

void

)

[static]

Get last host error

Definition at line 550 of file OSGSocket.cpp.

Referenced by getHostErrorStr(), and osg::SocketHostError::SocketHostError().

{
#ifdef WIN32
    return WSAGetLastError();
#else
    return h_errno;
#endif
}

std::string Socket::getErrorStr

(

void

)

[static]

Get last occured error as string

Definition at line 561 of file OSGSocket.cpp.

References getError().

Referenced by osg::SocketError::SocketError().

{
    const char *err=NULL;

#ifdef WIN32
    switch(getError())
    {
        case WSAEINTR: err= "WSAEINTR"; break;
        case WSAEBADF: err= "WSAEBADF"; break;
        case WSAEFAULT: err= "WSAEFAULT"; break; 
        case WSAEINVAL: err= "WSAEINVAL"; break; 
        case WSAEMFILE: err= "WSAEMFILE"; break; 
        case WSAEWOULDBLOCK: err= "WSAEWOULDBLOCK"; break; 
        case WSAEINPROGRESS: err= "WSAEINPROGRESS"; break; 
        case WSAEALREADY: err= "WSAEALREADY"; break; 
        case WSAENOTSOCK: err= "WSAENOTSOCK"; break; 
        case WSAEDESTADDRREQ: err= "WSAEDESTADDRREQ"; break; 
        case WSAEMSGSIZE: err= "WSAEMSGSIZE"; break; 
        case WSAEPROTOTYPE: err= "WSAEPROTOTYPE"; break; 
        case WSAENOPROTOOPT: err= "WSAENOPROTOOPT"; break; 
        case WSAEPROTONOSUPPORT: err= "WSAEPROTONOSUPPORT"; break; 
        case WSAESOCKTNOSUPPORT: err= "WSAESOCKTNOSUPPORT"; break; 
        case WSAEOPNOTSUPP: err= "WSAEOPNOTSUPP"; break; 
        case WSAEPFNOSUPPORT: err= "WSAEPFNOSUPPORT"; break; 
        case WSAEAFNOSUPPORT: err= "WSAEAFNOSUPPORT"; break; 
        case WSAEADDRINUSE: err= "WSAEADDRINUSE"; break; 
        case WSAEADDRNOTAVAIL: err= "WSAEADDRNOTAVAIL"; break; 
        case WSAENETDOWN: err= "WSAENETDOWN"; break; 
        case WSAENETUNREACH: err= "WSAENETUNREACH"; break; 
        case WSAENETRESET: err= "WSAENETRESET"; break; 
        case WSAECONNABORTED: err= "WSAECONNABORTED"; break; 
        case WSAECONNRESET: err= "WSAECONNRESET"; break; 
        case WSAENOBUFS: err= "WSAENOBUFS"; break; 
        case WSAEISCONN: err= "WSAEISCONN"; break; 
        case WSAENOTCONN: err= "WSAENOTCONN"; break; 
        case WSAESHUTDOWN: err= "WSAESHUTDOWN"; break; 
        case WSAETOOMANYREFS: err= "WSAETOOMANYREFS"; break; 
        case WSAETIMEDOUT: err= "WSAETIMEDOUT"; break; 
        case WSAECONNREFUSED: err= "WSAECONNREFUSED"; break; 
        case WSAELOOP: err= "WSAELOOP"; break; 
        case WSAENAMETOOLONG: err= "WSAENAMETOOLONG"; break; 
        case WSAEHOSTDOWN: err= "WSAEHOSTDOWN"; break; 
        case WSAEHOSTUNREACH: err= "WSAEHOSTUNREACH"; break; 
        case WSASYSNOTREADY: err= "WSASYSNOTREADY"; break; 
        case WSAVERNOTSUPPORTED: err= "WSAVERNOTSUPPORTED"; break; 
        case WSANOTINITIALISED: err= "WSANOTINITIALISED"; break; 
        case WSAHOST_NOT_FOUND: err= "WSAHOST_NOT_FOUND"; break; 
        case WSATRY_AGAIN: err= "WSATRY_AGAIN"; break; 
        case WSANO_RECOVERY: err= "WSANO_RECOVERY"; break; 
        case WSANO_DATA: err= "WSANO_DATA"; break; 
    }
#else
    err=strerror(getError());
#endif
    if(err)
        return std::string(err);
    else
        return std::string("Unknown error");
}

std::string Socket::getHostErrorStr

(

void

)

[static]

Get last occured host error as string

Definition at line 623 of file OSGSocket.cpp.

References getHostError().

Referenced by osg::SocketHostError::SocketHostError().

{
    const char *err;
#if defined(WIN32) || defined(__hpux)
    err = strerror(getHostError());
#else
    err = hstrerror(getHostError());
#endif
    if(err)
        return std::string(err);
    else
        return std::string("Unknown error");
}

---

Friends And Related Function Documentation

friend class SocketSelection [friend]

Definition at line 161 of file OSGSocket.h.

---

Member Data Documentation

int osg::Socket::_sd [protected]

Definition at line 155 of file OSGSocket.h.

Referenced by osg::StreamSocket::acceptFrom(), bind(), osg::SocketSelection::clearRead(), osg::SocketSelection::clearWrite(), osg::StreamSocket::close(), osg::DgramSocket::close(), connect(), getAddress(), getAvailable(), getReadBufferSize(), getWriteBufferSize(), osg::SocketSelection::isSetRead(), osg::SocketSelection::isSetWrite(), osg::DgramSocket::join(), osg::DgramSocket::leave(), listen(), osg::StreamSocket::open(), osg::DgramSocket::open(), osg::StreamSocket::operator=(), operator=(), osg::DgramSocket::operator=(), peek(), osg::DgramSocket::peekFrom(), recv(), recvAvailable(), osg::DgramSocket::recvFrom(), send(), osg::DgramSocket::sendTo(), setBlocking(), osg::StreamSocket::setDelay(), osg::DgramSocket::setMCastInterface(), osg::SocketSelection::setRead(), setReadBufferSize(), setReusePort(), osg::DgramSocket::setTTL(), osg::SocketSelection::setWrite(), and setWriteBufferSize().

int Socket::initialized = 0 [static, private]

Definition at line 167 of file OSGSocket.h.

Referenced by Socket().

---

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

• OSGSocket.h
• OSGSocket.cpp