osg::SocketSelection Class Reference
[Network]

Wait or check one or more sockets for read/write blocking. More...

#include <OSGSocketSelection.h>

List of all members.

Public Member Functions
Constructors
*	SocketSelection ()
	Constructor.
	SocketSelection (const SocketSelection &source)
	Copy constructor.
Destructor
*	~SocketSelection ()
	Destructor.
SocketSelection functions
*void	clear (void)
	Clear all settings.
void	clearRead (const Socket &soc)
	Clear read settings for the given socket.
void	clearWrite (const Socket &soc)
	Clear write settings for the given socket.
void	setRead (const Socket &soc)
	Set read flag for the given socket.
void	setWrite (const Socket &soc)
	Set write flag for the given socket.
bool	isSetRead (const Socket &soc)
	Check if read flag is set for a socket.
bool	isSetWrite (const Socket &soc)
	Check if write flag is set for a socket.
int	select (double time)
	Start selection.
int	select (double time, SocketSelection &result) const
	Start selection.
assignment
*const SocketSelection &	operator= (const SocketSelection &source)
	assignment
Protected Attributes
fd_set	_fdSetRead
fd_set	_fdSetWrite

---

Detailed Description

Author:

Marcus Roth

You can use a SocketSelection to wait for data on one ore more sockets. It is possible to use a timeout as a maximum wait time.

Example:

 SocketSelection sel;
 Socket s1,s2;
 ...
 sel.setRead(s1);
 sel.setRead(s2);
 if(sel.select(2))
 {
   if(sel.isSetRead(s1)) cout << "Data on s1" << endl;
   if(sel.isSetRead(s2)) cout << "Data on s2" << endl;
 }
 else
 {
   cout << "No data after 2 seconds" << endl;
 }
 

Definition at line 63 of file OSGSocketSelection.h.

---

Constructor & Destructor Documentation

SocketSelection::SocketSelection (   )

Definition at line 116 of file OSGSocketSelection.cpp. References clear(). { clear(); }

SocketSelection::SocketSelection (  const SocketSelection &  source  )

Definition at line 124 of file OSGSocketSelection.cpp. : _fdSetRead (source._fdSetRead), _fdSetWrite(source._fdSetWrite) { }

SocketSelection::~SocketSelection (   )

Definition at line 133 of file OSGSocketSelection.cpp. { }

---

Member Function Documentation

void SocketSelection::clear (  void   )

Definition at line 140 of file OSGSocketSelection.cpp. References _fdSetRead, and _fdSetWrite. Referenced by SocketSelection(). { FD_ZERO(&_fdSetRead); FD_ZERO(&_fdSetWrite); }

void SocketSelection::clearRead (  const Socket &  sock  )

Parameters: sock  For this socket the read flag is cleared Definition at line 150 of file OSGSocketSelection.cpp. References _fdSetRead, and osg::Socket::_sd. Referenced by osg::GroupSockConnection::wait(). { FD_CLR(sock._sd,&_fdSetRead); }

void SocketSelection::clearWrite (  const Socket &  sock  )

Parameters: sock  For this socket the write flag is cleared Definition at line 159 of file OSGSocketSelection.cpp. References _fdSetWrite, and osg::Socket::_sd. { FD_CLR(sock._sd,&_fdSetWrite); }

void SocketSelection::setRead (  const Socket &  sock  )

Parameters: sock  For this socket the read flag is set Definition at line 168 of file OSGSocketSelection.cpp. References _fdSetRead, and osg::Socket::_sd. Referenced by osg::GroupMCastConnection::checkChannels(), osg::PointMCastConnection::recvNextDgram(), osg::GroupSockConnection::selectChannel(), osg::GroupSockConnection::wait(), and osg::Socket::waitReadable(). { FD_SET(sock._sd,&_fdSetRead); }

void SocketSelection::setWrite (  const Socket &  sock  )

Parameters: sock  For this socket the write flag is set Definition at line 177 of file OSGSocketSelection.cpp. References _fdSetWrite, and osg::Socket::_sd. Referenced by osg::Socket::waitWritable(). { FD_SET(sock._sd,&_fdSetWrite); }

bool SocketSelection::isSetRead (  const Socket &  sock  )

Parameters: sock  For this socket the read flag is tested Definition at line 249 of file OSGSocketSelection.cpp. References _fdSetRead, and osg::Socket::_sd. Referenced by osg::GroupMCastConnection::checkChannels(), osg::PointMCastConnection::recvNextDgram(), osg::GroupSockConnection::selectChannel(), and osg::GroupSockConnection::wait(). { if(FD_ISSET(sock._sd, &_fdSetRead)) return true; else return false; }

bool SocketSelection::isSetWrite (  const Socket &  sock  )

Parameters: sock  For this socket the write flag is tested Definition at line 261 of file OSGSocketSelection.cpp. References _fdSetWrite, and osg::Socket::_sd. { if(FD_ISSET(sock._sd, &_fdSetWrite)) return true; else return false; }

int SocketSelection::select (  double  duration  )

Wait for the first read or write flag to be true. All other flags are cleared. Parameters: duration  Maximum wait time in seconds Returns: Number of set flags Definition at line 191 of file OSGSocketSelection.cpp. References _fdSetRead, and _fdSetWrite. Referenced by osg::GroupMCastConnection::checkChannels(), osg::PointMCastConnection::recvNextDgram(), select(), osg::GroupSockConnection::selectChannel(), osg::GroupSockConnection::wait(), osg::Socket::waitReadable(), and osg::Socket::waitWritable(). { timeval tVal,*tValP; int count; if(duration<0) { tValP=NULL; } else { tVal.tv_sec = int( duration ); tVal.tv_usec = int( (duration-tVal.tv_sec)*1000000 ); tValP=&tVal; } do { count=::select(FD_SETSIZE, &_fdSetRead, &_fdSetWrite, NULL, tValP); if(count < 0) { #ifndef WIN32 // select was interrupted by a signal. Ignore this // and retry to select if(errno != EINTR) throw SocketError("select()"); #else throw SocketError("select()"); #endif } } while(count < 0); return count; }

int SocketSelection::select (  double  duration, SocketSelection &  result )  const

Wait for the first read or write flag to be true. The resulting flags are set in result. Parameters: duration  Maximum wait time in seconds result  Result selection Returns: Number of set flags Definition at line 239 of file OSGSocketSelection.cpp. References select(). { result=*this; return result.select(duration); }

const SocketSelection & SocketSelection::operator= (  const SocketSelection &  source  )

Definition at line 274 of file OSGSocketSelection.cpp. References _fdSetRead, and _fdSetWrite. { _fdSetRead =source._fdSetRead; _fdSetWrite=source._fdSetWrite; return *this; }

---

Member Data Documentation

fd_set osg::SocketSelection::_fdSetRead [protected]

Definition at line 108 of file OSGSocketSelection.h. Referenced by clear(), clearRead(), isSetRead(), operator=(), select(), and setRead().

fd_set osg::SocketSelection::_fdSetWrite [protected]

Definition at line 109 of file OSGSocketSelection.h. Referenced by clear(), clearWrite(), isSetWrite(), operator=(), select(), and setWrite().

---

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

• OSGSocketSelection.h
• OSGSocketSelection.cpp

---