JLANG::JFileDescriptorMask Class Reference

Auxiliary class for method select. More...

#include <JFileDescriptorMask.hh>

Inheritance diagram for JLANG::JFileDescriptorMask:

Public Member Functions
	JFileDescriptorMask ()
	Default constructor.
	JFileDescriptorMask (const JAbstractFile &file)
	Constructor.
	JFileDescriptorMask (const int file_descriptor)
	Constructor.
const fd_set *	get () const
	Get pointer to mask.
fd_set *	get ()
	Get pointer to mask.
const fd_set *	operator& () const
	Address of operator.
fd_set *	operator& ()
	Address of operator.
void	reset (const bool option=true)
	Reset mask.
void	set (const int file_descriptor)
	Set file descriptor.
void	set (const JAbstractFile &file)
	Set file.
void	reset (const int file_descriptor)
	Reset file descriptor.
void	reset (const JAbstractFile &file)
	Reset file.
bool	has (const int file_descriptor) const
	Has file descriptor.
bool	has (const JAbstractFile &file) const
	Has file.
int	getNumberOfFileDescriptors () const
	Get number of file descriptors.
bool	empty () const
	Check setting of file descriptors.
bool	in_avail (JTimeval timeout=JTimeval::min())
	Check availability of input.
bool	out_avail (JTimeval timeout=JTimeval::min())
	Check availability of output.

Static Public Attributes
static const int	MAXIMUM_FILE_DESCRIPTOR = FD_SETSIZE

Private Attributes
int	maximum_file_descriptor
int	number_of_file_descriptors

Detailed Description

Auxiliary class for method select.

This class encapsulates the fd_set data structure.

Definition at line 25 of file JFileDescriptorMask.hh.

Constructor & Destructor Documentation

JFileDescriptorMask() [1/3]

JLANG::JFileDescriptorMask::JFileDescriptorMask ( )

inline

Default constructor.

Definition at line 37 of file JFileDescriptorMask.hh.

                          :
      maximum_file_descriptor   (0),
      number_of_file_descriptors(0)
    {
      FD_ZERO(get());
    }

JFileDescriptorMask() [2/3]

JLANG::JFileDescriptorMask::JFileDescriptorMask ( const JAbstractFile & file )

inline

Constructor.

Parameters

file	file descriptor

Definition at line 50 of file JFileDescriptorMask.hh.

                                                   :
      maximum_file_descriptor   (0),
      number_of_file_descriptors(0)
    {
      FD_ZERO(get());
 
      set(file);
    }

JFileDescriptorMask() [3/3]

JLANG::JFileDescriptorMask::JFileDescriptorMask ( const int file_descriptor )

inline

Constructor.

Parameters

file_descriptor

file descriptor

Definition at line 65 of file JFileDescriptorMask.hh.

                                                   :
      maximum_file_descriptor   (0),
      number_of_file_descriptors(0)
    {
      FD_ZERO(get());
 
      set(file_descriptor);
    }

Member Function Documentation

get() [1/2]

const fd_set * JLANG::JFileDescriptorMask::get ( ) const

inline

Get pointer to mask.

Returns

pointer to mask

Definition at line 80 of file JFileDescriptorMask.hh.

    {
      return static_cast<const fd_set*>(this);
    }

get() [2/2]

fd_set * JLANG::JFileDescriptorMask::get ( )

inline

Get pointer to mask.

Returns

pointer to mask

Definition at line 91 of file JFileDescriptorMask.hh.

    {
      return static_cast<fd_set*>(this);
    }

operator&() [1/2]

const fd_set * JLANG::JFileDescriptorMask::operator& ( ) const

inline

Address of operator.

Returns

pointer to mask

Definition at line 102 of file JFileDescriptorMask.hh.

    {
      return get();
    }

operator&() [2/2]

fd_set * JLANG::JFileDescriptorMask::operator& ( )

inline

Address of operator.

Returns

pointer to mask

Definition at line 113 of file JFileDescriptorMask.hh.

    {
      return get();
    }

reset() [1/3]

void JLANG::JFileDescriptorMask::reset ( const bool option = true )

inline

Reset mask.

A hard reset causes the reset of the complete mask whereas a soft reset causes the reset of the internal parameters only.

Parameters

option

true hard reset; else soft reset

Definition at line 126 of file JFileDescriptorMask.hh.

    {
      if (option) {
 
        switch (number_of_file_descriptors) {
 
        case 0:
          break;
          
        case 1:
          FD_CLR(maximum_file_descriptor, get());
          break;
          
        default:
          FD_ZERO(get());
          break;
        }
      }
 
      maximum_file_descriptor    = 0;
      number_of_file_descriptors = 0;
    }

set() [1/2]

void JLANG::JFileDescriptorMask::set ( const int file_descriptor )

inline

Set file descriptor.

Parameters

file_descriptor

file descriptor

Definition at line 155 of file JFileDescriptorMask.hh.

    {
      if (!has(file_descriptor)) {
 
        FD_SET(file_descriptor, get());
 
        if (file_descriptor > maximum_file_descriptor) {
          maximum_file_descriptor = file_descriptor;
        }
 
        ++number_of_file_descriptors;
      }
    }

set() [2/2]

void JLANG::JFileDescriptorMask::set ( const JAbstractFile & file )

inline

Set file.

Parameters

file

file

Definition at line 175 of file JFileDescriptorMask.hh.

    {
      set(file.getFileDescriptor());
    }

reset() [2/3]

void JLANG::JFileDescriptorMask::reset ( const int file_descriptor )

inline

Reset file descriptor.

Parameters

file_descriptor

file descriptor

Definition at line 186 of file JFileDescriptorMask.hh.

    {
      if (has(file_descriptor)) {
 
        FD_CLR(file_descriptor, get());
 
        while (!has(maximum_file_descriptor) && maximum_file_descriptor != 0) {
          --maximum_file_descriptor;
        }
        
        --number_of_file_descriptors;
      }
    }

reset() [3/3]

void JLANG::JFileDescriptorMask::reset ( const JAbstractFile & file )

inline

Reset file.

Parameters

file

file

Definition at line 206 of file JFileDescriptorMask.hh.

    {
      reset(file.getFileDescriptor());
    }

has() [1/2]

bool JLANG::JFileDescriptorMask::has ( const int file_descriptor ) const

inline

Has file descriptor.

Parameters

file_descriptor

file descriptor

Returns

true if file descriptor set; else false

Definition at line 218 of file JFileDescriptorMask.hh.

    {
      return FD_ISSET(file_descriptor, get());
    }

has() [2/2]

bool JLANG::JFileDescriptorMask::has ( const JAbstractFile & file ) const

inline

Has file.

Parameters

file

file

Returns

true if file set; else false

Definition at line 230 of file JFileDescriptorMask.hh.

    {
      return has(file.getFileDescriptor());
    }

getNumberOfFileDescriptors()

int JLANG::JFileDescriptorMask::getNumberOfFileDescriptors ( ) const

inline

Get number of file descriptors.

Returns

number of file descriptors

Definition at line 241 of file JFileDescriptorMask.hh.

    {
      return maximum_file_descriptor;
    }

empty()

bool JLANG::JFileDescriptorMask::empty ( ) const

inline

Check setting of file descriptors.

Returns

true if no file descriptors are set; else false

Definition at line 252 of file JFileDescriptorMask.hh.

    {
      return number_of_file_descriptors == 0;
    }

in_avail()

bool JLANG::JFileDescriptorMask::in_avail ( JTimeval timeout = JTimeval::min() )

inline

Check availability of input.

This method returns true if at least one byte can be read without blocking. Following the select call, this method overwrites the internal mask!

Parameters

timeout

timeout

Returns

true if ready to read; else false

Definition at line 266 of file JFileDescriptorMask.hh.

    {
      const int nfds = ::select(getNumberOfFileDescriptors() + 1, get(), NULL, NULL, &timeout);
 
      if      (nfds >  0)
        return true;
      else if (nfds == 0)
        return false;
      else
        THROW(JSocketException, "select error " << errno);
    }

out_avail()

bool JLANG::JFileDescriptorMask::out_avail ( JTimeval timeout = JTimeval::min() )

inline

Check availability of output.

This method returns true if at least one byte can be written without blocking. Following the select call, this method overwrites the internal mask!

Parameters

timeout

timeout

Returns

true if ready to write; else false

Definition at line 287 of file JFileDescriptorMask.hh.

    {
      const int nfds = ::select(getNumberOfFileDescriptors() + 1, NULL, get(), NULL, &timeout) > 0;
 
      if      (nfds >  0)
        return true;
      else if (nfds == 0)
        return false;
      else
        THROW(JSocketException, "select error " << errno);
    }

Member Data Documentation

MAXIMUM_FILE_DESCRIPTOR

const int JLANG::JFileDescriptorMask::MAXIMUM_FILE_DESCRIPTOR = FD_SETSIZE

static

Definition at line 31 of file JFileDescriptorMask.hh.

maximum_file_descriptor

int JLANG::JFileDescriptorMask::maximum_file_descriptor

private

Definition at line 301 of file JFileDescriptorMask.hh.

number_of_file_descriptors

int JLANG::JFileDescriptorMask::number_of_file_descriptors

private

Definition at line 302 of file JFileDescriptorMask.hh.

---

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

• JFileDescriptorMask.hh