osg::DgramSocket Class Reference
[Network]

Datagramm socket handler. More...

#include <OSGDgramSocket.h>

Inheritance diagram for osg::DgramSocket:

List of all members.

Public Member Functions
Constructors
	DgramSocket ()
	DgramSocket (const DgramSocket &source)
open/close
virtual void	open (void)
virtual void	close (void)
read, write
int	recvFrom (void *buf, int size, SocketAddress &from)
int	peekFrom (void *buf, int size, SocketAddress &from)
int	recvFrom (NetworkMessage &msg, SocketAddress &from)
int	sendTo (const void *buf, int size, const SocketAddress &to)
int	sendTo (NetworkMessage &msg, const SocketAddress &to)
multicast
void	join (const SocketAddress &group, const SocketAddress &interf=SocketAddress(SocketAddress::ANY))
void	leave (const SocketAddress &group, const SocketAddress &interf=SocketAddress(SocketAddress::ANY))
void	setTTL (unsigned char ttl)
void	setMCastInterface (const SocketAddress &interf)
assignment
const DgramSocket &	operator= (const DgramSocket &source)
open, close, connect
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	recv (NetworkMessage &msg)
int	recvAvailable (void *buf, int size)
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)
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
Private Types
typedef Socket	Inherited
Static Private Attributes
static char	cvsid []

---

Detailed Description

This class is a handler to packet oriented socket. open will assing a udp socket and close releases the socket. Messages send with DgramSockets can be lost or the order in which they arrive can be changed.

 char buffer[100];
 DgramSocket s;
 SocketAddress from;
 s.open();
 s.sendTo(buffer,10,SocketAddress("serverhost.com",4567));
 s.recvFrom(buffer,10,from);
 s.close();
 

Definition at line 56 of file OSGDgramSocket.h.

---

Member Typedef Documentation

typedef Socket osg::DgramSocket::Inherited [private]

Definition at line 124 of file OSGDgramSocket.h.

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

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, inherited]

Socket length type. Used to hide the different interface implementations

Definition at line 146 of file OSGSocket.h.

---

Constructor & Destructor Documentation

DgramSocket::DgramSocket

(

)

Constructor. Use open to assign a system socket. No system socket is assigned by the constructor.

See also:

DgramSocket::open

Definition at line 104 of file OSGDgramSocket.cpp.

                        :
    Socket()
{
}

DgramSocket::DgramSocket

(

const DgramSocket &

source

)

Copy constructor

Definition at line 111 of file OSGDgramSocket.cpp.

                                                 :
    Socket(source)
{
}

---

Member Function Documentation

void DgramSocket::open

(

void

)

[virtual]

Assign a socket. Open assignes a system socket to the DgramSocket.

See also:

Socket::close

Implements osg::Socket.

Definition at line 123 of file OSGDgramSocket.cpp.

References osg::Socket::_sd, and setTTL().

Referenced by osg::ClusterServer::acceptClient(), osg::GroupMCastConnection::GroupMCastConnection(), osg::ClusterWindow::init(), and osg::PointMCastConnection::initialize().

{
    _sd = socket(AF_INET, SOCK_DGRAM, 0);
    if(_sd<0)
    {
        throw SocketError("socket()");
    }
    // all dgram sockets are allowed to send broadcast
    int on = 1;
    if(::setsockopt(_sd, 
                    SOL_SOCKET, SO_BROADCAST, 
                    (SocketOptT*)&on, sizeof(on)) < 0)
    {
        throw SocketError("setsockopt(,SOL_SOCKET,SO_BROADCAST)");
    }
    // by default, multicast only in local network
    setTTL(2);
}

void DgramSocket::close

(

void

)

[virtual]

close socket

Implements osg::Socket.

Definition at line 144 of file OSGDgramSocket.cpp.

References osg::Socket::_sd.

Referenced by osg::ClusterServer::acceptClient(), osg::ClusterWindow::init(), osg::GroupMCastConnection::~GroupMCastConnection(), and osg::PointMCastConnection::~PointMCastConnection().

{
#ifdef WIN32
    ::closesocket(_sd);
#else
    ::close(_sd);
#endif
}

int DgramSocket::recvFrom	(	void *	buf,
		int	size,
		SocketAddress &	from
	)

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

See also:

Socket::recvAvailable Socket::recv

Definition at line 161 of file OSGDgramSocket.cpp.

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

Referenced by osg::ClusterServer::acceptClient(), osg::ClusterWindow::init(), recvFrom(), osg::PointMCastConnection::recvNextDgram(), and osg::GroupMCastConnection::sendQueue().

{
    int len;
    SocketLenT addrLen=from.getSockAddrSize();

#ifndef WIN32
    do
    {
#endif
        len=recvfrom(_sd,
                     (char*)buf,
                     size,
                     0,
                     from.getSockAddr(),
                     &addrLen);
#ifndef WIN32
    } 
    while(len < 0 && errno == EAGAIN);
#endif

    if(len < 0)
    {
#if defined WIN32
        if(getError() == WSAECONNRESET)
        {
            throw SocketConnReset("recvfrom");
        }
        if(getError() == WSAEMSGSIZE)
        {
            len=size;
        }
        else
#endif
        throw SocketError("recvfrom()");
    }
    return len;
}

int DgramSocket::peekFrom	(	void *	buf,
		int	size,
		SocketAddress &	from
	)

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 Socket::recv

Definition at line 206 of file OSGDgramSocket.cpp.

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

{
    int len;
    SocketLenT addrLen=from.getSockAddrSize();

    len=recvfrom(_sd,
                 (char*)buf,
                 size,
                 MSG_PEEK,
                 from.getSockAddr(),
                 &addrLen);
    if(len == -1)
    {
#if defined WIN32
        if(getError() == WSAECONNRESET)
        {
            throw SocketConnReset("recvfrom");
        }
        if(getError() == WSAEMSGSIZE)
        {
            len=size;
        }
        else
#endif
        throw SocketError("recvfrom()");
    }
    return len;
}

int DgramSocket::recvFrom	(	NetworkMessage &	msg,
		SocketAddress &	from
	)

Receive a NetworkMessage. Workes like recv, but buffer and size is taken from the NetworkMessage

See also:

Socket::recv

Definition at line 239 of file OSGDgramSocket.cpp.

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

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

int DgramSocket::sendTo	(	const void *	buf,
		int	size,
		const SocketAddress &	to
	)

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

See also:

recv Socket::send

Definition at line 251 of file OSGDgramSocket.cpp.

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

Referenced by osg::ClusterServer::acceptClient(), osg::PointMCastConnection::combineAck(), osg::ClusterWindow::init(), osg::PointMCastConnection::recvNextDgram(), osg::PointMCastConnection::recvQueue(), osg::GroupMCastConnection::sendQueue(), sendTo(), and osg::GroupMCastConnection::write().

{
    int len;

    // send Request
    len=sendto(_sd,
               (const char*)buf,size,
#if defined(WIN32) && defined(MSG_NOSIGNAL)
               MSG_NOSIGNAL,
#else
               0,
#endif
               to.getSockAddr(),
               to.getSockAddrSize());
#ifdef _sgi
    /* Irix simetimes returns ENOBUFS on blocking write.
       Retry until buffer is available */
    while(len == -1 && errno == ENOBUFS)
    {
        usleep(100);
        len=sendto(_sd,
                   (const char*)buf,size,
                   0,
                   to.getSockAddr(),
                   to.getSockAddrSize());
    }
#endif

    if(len == -1)
    {
        throw SocketError("sendto()");
    }
    return len;
}

int DgramSocket::sendTo	(	NetworkMessage &	msg,
		const SocketAddress &	to
	)

Send a NetworkMessage to an address. Workes like send, but buffer and size is taken from the NetworkMessage.

See also:

Socket::send

Definition at line 290 of file OSGDgramSocket.cpp.

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

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

void DgramSocket::join	(	const SocketAddress &	group,
		const SocketAddress &	interf = SocketAddress(SocketAddress::ANY)
	)

The socket will receive all messages from the given multicast address It is possible to join more then on goup.

Definition at line 303 of file OSGDgramSocket.cpp.

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

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

{
    struct ip_mreq joinAddr;
    int rc;

    // group to join
    joinAddr.imr_multiaddr.s_addr =
        ((sockaddr_in*)group.getSockAddr())->sin_addr.s_addr;

    // interface that joins. (equal to bind address)
    joinAddr.imr_interface =
        ((struct sockaddr_in*)interf.getSockAddr())->sin_addr;
    rc=setsockopt(_sd,
                  IPPROTO_IP,
                  IP_ADD_MEMBERSHIP,
                  (SocketOptT*)&joinAddr,
                  sizeof(joinAddr));
    if(rc < 0)
    {
        throw SocketError("setsockopt(IPPROTO_IP,IP_ADD_MEMBERSHIP)");
    }
}

void DgramSocket::leave	(	const SocketAddress &	group,
		const SocketAddress &	interf = SocketAddress(SocketAddress::ANY)
	)

Leave a multicast group. Don't receive messages from the given group.

Definition at line 328 of file OSGDgramSocket.cpp.

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

{
    struct ip_mreq joinAddr;
    int rc;

    // group to join
    joinAddr.imr_multiaddr.s_addr =
        ((sockaddr_in*)group.getSockAddr())->sin_addr.s_addr;
    // interface that joins. (equal to bind address)
    joinAddr.imr_interface =
        ((sockaddr_in*)interf.getSockAddr())->sin_addr;
    rc=setsockopt(_sd,
                  IPPROTO_IP,
                  IP_DROP_MEMBERSHIP,
                  (SocketOptT*)&joinAddr,
                  sizeof(joinAddr));
    if(rc < 0)
    {
        throw SocketError("setsockopt(IPPROTO_IP,IP_DROP_MEMBERSHIP)");
    }
}

void DgramSocket::setTTL

(

unsigned char

ttl

)

Set TTL for broadcast and multicast. Defines how many routers a package will pass until it is deleted. 0 = local host, 1 = local network, ...

Definition at line 354 of file OSGDgramSocket.cpp.

References osg::Socket::_sd.

Referenced by osg::ClusterWindow::init(), open(), and osg::GroupMCastConnection::setParams().

{
    int rc=setsockopt(_sd, IPPROTO_IP,IP_MULTICAST_TTL,
                      (SocketOptT*)&ttl,sizeof(ttl));
    if(rc < 0)
    {
        throw SocketError("setsockopt(IPPROTO_IP,IP_MULTICAST_TTL)");
    }
}

void DgramSocket::setMCastInterface

(

const SocketAddress &

interf

)

Spcify the network interface for outgoing multicast packages

Definition at line 367 of file OSGDgramSocket.cpp.

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

Referenced by osg::ClusterWindow::init(), osg::PointMCastConnection::initialize(), and osg::GroupMCastConnection::initialize().

{
    int rc=setsockopt(_sd,
                      IPPROTO_IP,
                      IP_MULTICAST_IF,
                      (SocketOptT*)interf.getSockAddr(),
                      interf.getSockAddrSize());
    if(rc < 0)
    {
        throw SocketError("setsockopt(IPPROTO_IP,IP_MULTICAST_IF)");
    }

}

const DgramSocket & DgramSocket::operator=

(

const DgramSocket &

source

)

assignment

Definition at line 386 of file OSGDgramSocket.cpp.

References osg::Socket::_sd.

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

void Socket::bind

(

const SocketAddress &

address = SocketAddress(SocketAddress::ANY)

)

[inherited]

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 osg::Socket::_sd, osg::Socket::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

)

[inherited]

Set queue length for incomming connection requests

Definition at line 180 of file OSGSocket.cpp.

References osg::Socket::_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

)

[inherited]

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 osg::Socket::_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
	)			[inherited]

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 osg::Socket::_sd, and osg::Socket::getError().

Referenced by osg::PointSockPipeline::initialize(), osg::PointMCastConnection::initialize(), osg::Socket::peek(), osg::PointSockPipeline::read(), osg::PointSockConnection::read(), osg::PointSockPipeline::readBuffer(), osg::PointSockConnection::readBuffer(), osg::Socket::recv(), osg::Socket::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::recv

(

NetworkMessage &

msg

)

[inherited]

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(), osg::Socket::peek(), osg::Socket::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::recvAvailable	(	void *	buf,
		int	size
	)			[inherited]

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 osg::Socket::_sd, osg::Socket::getError(), and osg::Socket::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::peek	(	void *	buf,
		int	size
	)			[inherited]

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 osg::Socket::_sd, osg::Socket::getError(), and osg::Socket::recv().

Referenced by osg::Socket::recv(), and 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
	)			[inherited]

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 osg::Socket::_sd.

Referenced by osg::PointSockPipeline::initialize(), osg::PointMCastConnection::initialize(), osg::PointSockPipeline::read(), osg::PointSockPipeline::readBuffer(), osg::Socket::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

)

[inherited]

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(), osg::Socket::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

)

[inherited]

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 osg::Socket::_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

)

[inherited]

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 osg::Socket::_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

)

[inherited]

Get bound SocketAddress

See also:

SocketAddress

Definition at line 426 of file OSGSocket.cpp.

References osg::Socket::_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

)

[inherited]

Set the internal read buffer size

See also:

Socket::getReadBufferSize

Definition at line 442 of file OSGSocket.cpp.

References osg::Socket::_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

)

[inherited]

Set the internal write buffer size

See also:

Socket::getWriteBufferSize

Definition at line 451 of file OSGSocket.cpp.

References osg::Socket::_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

)

[inherited]

Get internal read buffer size

See also:

Socket::setReadBufferSize

Definition at line 460 of file OSGSocket.cpp.

References osg::Socket::_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

)

[inherited]

Get internal write buffer size

See also:

Socket::setWriteBufferSize

Definition at line 471 of file OSGSocket.cpp.

References osg::Socket::_sd.

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

int Socket::getAvailable

(

void

)

[inherited]

Get number of bytes in the internal read buffer

Definition at line 481 of file OSGSocket.cpp.

References osg::Socket::_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

)

[inherited]

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

)

[inherited]

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;
}

int Socket::getError

(

void

)

[static, inherited]

Get last occured error

Definition at line 539 of file OSGSocket.cpp.

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

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

int Socket::getHostError

(

void

)

[static, inherited]

Get last host error

Definition at line 550 of file OSGSocket.cpp.

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

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

std::string Socket::getErrorStr

(

void

)

[static, inherited]

Get last occured error as string

Definition at line 561 of file OSGSocket.cpp.

References osg::Socket::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, inherited]

Get last occured host error as string

Definition at line 623 of file OSGSocket.cpp.

References osg::Socket::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");
}

---

Member Data Documentation

char osg::DgramSocket::cvsid[] [static, private]

Definition at line 126 of file OSGDgramSocket.h.

int osg::Socket::_sd [protected, inherited]

Definition at line 155 of file OSGSocket.h.

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

---

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

• OSGDgramSocket.h
• OSGDgramSocket.cpp