FakeSelectSocketDescriptor.hxx

#if !defined(FakeSelectSocketDescriptor_hxx)
#define FakeSelectSocketDescriptor_hxx

namespace flowmanager
{

/**
   This class is used to generate a fake socket descriptor
   than can be used by applications that implement a select/process
   loop.  This is required so that STUN messages not related to the
   actual data transmission, do not cause a select call to wake up
   if using select on the actual socket descriptor.

  Author: Scott Godin (sgodin AT SipSpectrum DOT com)
*/

class FakeSelectSocketDescriptor
{
public:
   FakeSelectSocketDescriptor();
   ~FakeSelectSocketDescriptor();

   unsigned int getSocketDescriptor();

   // queues fake data on the descriptor so that it signals

   void send();  

   // dequeue fake data from the descriptor

   void receive();


private:
#ifndef WIN32

   int mPipe[2];

#else

   int mSocket;

#endif

};

}

#endif


/* ====================================================================

 Copyright (c) 2007-2008, Plantronics, Inc.
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are 
 met:

 1. Redistributions of source code must retain the above copyright 
    notice, this list of conditions and the following disclaimer. 

 2. Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution. 

 3. Neither the name of Plantronics nor the names of its contributors 
    may be used to endorse or promote products derived from this 
    software without specific prior written permission. 

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 ==================================================================== */