OW_Select.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, 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:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - 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.
*
*  - Neither the name of Vintela, Inc. 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 Vintela, Inc. OR THE 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.
*******************************************************************************/

#ifndef OW_SELECT_HPP_
#define OW_SELECT_HPP_
#include "OW_config.h"
#include "OW_Types.hpp"
#include "OW_Array.hpp"
#include "OW_SelectableIFC.hpp"

// The classes and functions defined in this file are not meant for general
// use, they are internal implementation details.  They may change at any time.

namespace OW_NAMESPACE
{

typedef Array<Select_t> SelectTypeArray;
namespace Select
{
   const int SELECT_TIMEOUT = -2;
   const int SELECT_ERROR = -1;
   const int SELECT_INTERRUPTED = -3;
   const int SELECT_NOT_IMPLEMENTED = -4;
   const UInt32 INFINITE_TIMEOUT = ~0U;
   
   OW_COMMON_API int select(const SelectTypeArray& selarray, UInt32 ms = INFINITE_TIMEOUT);

   struct SelectObject
   {
      SelectObject(Select_t s_)
      : s(s_)
      , waitForRead(false)
      , waitForWrite(false)
      , readAvailable(false)
      , writeAvailable(false)
      , wasError(false)
      {
      }

      Select_t s;
      bool waitForRead; 
      bool waitForWrite; 
      bool readAvailable;
      bool writeAvailable;
      bool wasError;
   };
   typedef Array<SelectObject> SelectObjectArray;

   OW_COMMON_API int selectRW(SelectObjectArray& selarray, UInt32 ms = INFINITE_TIMEOUT);

} // end namespace Select

} // end namespace OW_NAMESPACE

#endif // OW_SELECT_HPP_

---