DwmDescriptor.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmDescriptor.hh 8618 $
// @(#) $Id: DwmDescriptor.hh 8618 2016-05-30 04:12:07Z dwm $
//===========================================================================
//  Copyright (c) Daniel W. McRobb 1998-2006, 2016
//  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. The names of the authors and copyright holders may not be used to
//    endorse or promote products derived from this software without
//    specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------

#ifndef _DWMDESCRIPTOR_HH_
#define _DWMDESCRIPTOR_HH_

extern "C" {
#include <sys/types.h>
#include <sys/time.h>
#include <sys/uio.h>
#include <unistd.h>
}

#include "DwmIO.hh"

namespace Dwm {
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Descriptor
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Descriptor();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Descriptor(const Descriptor & d);

    Descriptor(int d);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Descriptor & operator = (const Descriptor & d);
    
    // Descriptor & operator = (int fd);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual ~Descriptor();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Close();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Attach(int fd);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool Detach();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool SetNonBlocking();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool SetBlocking();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual operator int () const
    {
      return(this->_fd);
    }

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool FdSet(fd_set & fdSet);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool FdClr(fd_set & fdSet);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual bool FdIsSet(fd_set & fdSet);

    virtual bool ReadWouldBlock();
    
  protected:
    int            _fd;
  };
  
}  // namespace Dwm

#endif  // _DWMDESCRIPTOR_HH_

//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++/la
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------