#include <vsnet_socketset.h>

Inheritance diagram for SocketSet:

Public Member Functions
	SocketSet (bool blockmainthread=false)

	~SocketSet ()

bool	addDownloadManager (boost::shared_ptr< VsnetDownload::Client::Manager >mgr)

bool	addDownloadManager (boost::shared_ptr< VsnetDownload::Server::Manager >mgr)

void	set (VsnetSocketBase *s)

void	unset (VsnetSocketBase *s)
	The upper thread takes a socket out of the _autoset. More...

int	wait (timeval *tv=NULL)
	The upper thread waits for something to arrive on the socket. More...

void	add_pending (int fd)

void	rem_pending (int fd)

void	waste_time (long sec, long usec)
	unthreaded case More...

virtual void	run ()

void	wakeup ()

void	predestroy ()
	only call predestroy if you know the whole set will be destructed soonish–clears the autoset More...

Public Member Functions inherited from VSThread
	VSThread (bool detached)

virtual	~VSThread ()

void	start ()

void	join ()

Additional Inherited Members
Static Public Member Functions inherited from VSThread
static void	init ()
	global initialization function for the thread subsystem More...

Detailed Description

Definition at line 56 of file vsnet_socketset.h.

Constructor & Destructor Documentation

SocketSet::SocketSet ( bool blockmainthread = false)

Definition at line 12 of file vsnet_socketset.cpp.

                                            :
     VSThread( false )
     , _blockmain( blockmainthread )
     , _blockmain_pending( 0 )
 {
 #ifndef USE_NO_THREAD
     _thread_end = false;
 #endif
     FD_ZERO( &_blockmain_set );
 }

SocketSet::~SocketSet ( )

Definition at line 23 of file vsnet_socketset.cpp.

References VSMutex::lock(), VSMutex::unlock(), and VSCond::wait().

 {
 #ifndef USE_NO_THREAD
     _thread_mx.lock();
     _thread_end = true;
     _blockmain  = false;     //signalling would be dangerous
     _thread_wakeup.closewrite();
     _thread_cond.wait( _thread_mx );
     _thread_wakeup.closeread();
     _thread_mx.unlock();
 #endif
 }

Member Function Documentation

void SocketSet::add_pending ( int fd)

Definition at line 120 of file vsnet_socketset.cpp.

References VSMutex::lock(), and VSMutex::unlock().

Referenced by VsnetTCPSocket::inner_complete_a_packet(), VsnetUDPSocket::lower_selected(), VsnetTCPSocket::lower_selected(), and ServerSocketTCP::lower_selected().

 {
     if (_blockmain) {
         _blockmain_mx.lock();
         FD_SET( fd, &_blockmain_set );
         if (fd >= _blockmain_pending) _blockmain_pending = fd+1;
         _blockmain_mx.unlock();
     }
 }

bool SocketSet::addDownloadManager ( boost::shared_ptr< VsnetDownload::Client::Manager > mgr)

Definition at line 39 of file vsnet_socketset.cpp.

Referenced by NetClient::NetClient().

 {
     if ( !_client_mgr.expired() ) return false;
     _client_mgr = mgr;
     return true;
 }

bool SocketSet::addDownloadManager ( boost::shared_ptr< VsnetDownload::Server::Manager > mgr)

Definition at line 46 of file vsnet_socketset.cpp.

 {
     if ( !_server_mgr.expired() ) return false;
     _server_mgr = mgr;
     return true;
 }

void SocketSet::predestroy ( )

only call predestroy if you know the whole set will be destructed soonish–clears the autoset

Definition at line 35 of file vsnet_socketset.cpp.

 {
     _autoset.clear();
 }

void SocketSet::rem_pending ( int fd)

Definition at line 130 of file vsnet_socketset.cpp.

References VSMutex::lock(), and VSMutex::unlock().

Referenced by ServerSocketTCP::acceptNewConn(), VsnetTCPSocket::isActive(), VsnetUDPSocket::recvbuf(), and VsnetTCPSocket::recvbuf().

 {
     if (_blockmain) {
         _blockmain_mx.lock();
         FD_CLR( fd, &_blockmain_set );
         if (fd == _blockmain_pending-1) {
             while (_blockmain_pending > 0) {
                 if ( FD_ISSET( _blockmain_pending-1, &_blockmain_set ) )
                     break;
                 _blockmain_pending -= 1;
             }
         }
         _blockmain_mx.unlock();
     }
 }

void SocketSet::run ( void )

virtual

Implements VSThread.

Definition at line 315 of file vsnet_socketset.cpp.

References VSMutex::lock(), VSCond::signal(), and VSMutex::unlock().

 {
 #ifndef USE_NO_THREAD
     while (!_thread_end)
         private_select( NULL );
     _thread_mx.lock();
     _thread_cond.signal();
     _thread_mx.unlock();
 #endif
 }

void SocketSet::set ( VsnetSocketBase * s)

Once a socket is registered using this function, setRead is automatically called for it before each select

Definition at line 53 of file vsnet_socketset.cpp.

Referenced by SOCKETALT::addToSet(), VsnetSocketBase::setSet(), and VsnetSocketBase::VsnetSocketBase().

 {
     _autoset.insert( s );
     private_wakeup();
 }

void SocketSet::unset ( VsnetSocketBase * s)

The upper thread takes a socket out of the _autoset.

Definition at line 59 of file vsnet_socketset.cpp.

Referenced by VsnetSocketBase::disconnect(), VsnetSocketBase::setSet(), and VsnetSocketBase::~VsnetSocketBase().

 {
     if ( _autoset.size() )
         _autoset.erase( s );
     private_wakeup();
 }

int SocketSet::wait ( timeval * tv = NULL)

The upper thread waits for something to arrive on the socket.

Definition at line 67 of file vsnet_socketset.cpp.

References COUT, and i.

Referenced by AccountServer::start().

 {
     //assert( _blockmain ); // can't call wait if we haven't ordered the feature (?)
     if (_blockmain_pending == 0) {
         int ret;
         do {
             if (tv == NULL) {
                 ret = private_select( NULL );
             } else {
                 timeval tvCopy( *tv );                 //select resets timeval.
                 ret = private_select( &tvCopy );
             }
         } while (ret == 1);
         return ret;
     } else {
 #ifdef VSNET_DEBUG
         std::ostringstream ostr;
         for (int i = 0; i < _blockmain_pending; i++)
             if ( FD_ISSET( i, &_blockmain_set ) ) ostr<<" "<<i;
         COUT<<"something pending for sockets:"
             <<ostr.str()
             <<" ("<<_blockmain_pending<<")"<<endl;
 #endif
         struct timeval zerotv;
         zerotv.tv_sec  = 0;
         zerotv.tv_usec = 0;
         return private_select( &zerotv );
     }
 }

void SocketSet::wakeup ( )

Definition at line 279 of file vsnet_socketset.cpp.

Referenced by VsnetDownload::Server::Manager::addCmdDownload(), VsnetDownload::Client::Manager::addItems(), and VsnetTCPSocket::sendbuf().

 {
     private_wakeup();
 }

void SocketSet::waste_time	(	long	sec,
		long	usec
	)

unthreaded case

Use this function liberally in you code. If you don't have a network thread, it will check select and return. If you have a place in your code where you want to wait anyway, replace your waiting function with a call to this function.

Definition at line 290 of file vsnet_socketset.cpp.

Referenced by NetClient::loginAcctLoop(), and VsnetTCPSocket::private_nothread_conditional_write().

 {
     struct timeval tv;
     tv.tv_sec  = sec;
     tv.tv_usec = usec;
     private_select( &tv );
 }

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

src/networking/lowlevel/vsnet_socketset.h
src/networking/lowlevel/vsnet_socketset.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation