Auxiliary class for method select.
More...
#include <JFileDescriptorMask.hh>
Auxiliary class for method select.
This class encapsulates the fd_set
data structure.
Definition at line 24 of file JFileDescriptorMask.hh.
◆ JFileDescriptorMask() [1/3]
JLANG::JFileDescriptorMask::JFileDescriptorMask |
( |
| ) |
|
|
inline |
◆ JFileDescriptorMask() [2/3]
JLANG::JFileDescriptorMask::JFileDescriptorMask |
( |
const JAbstractFile & |
file | ) |
|
|
inline |
◆ JFileDescriptorMask() [3/3]
JLANG::JFileDescriptorMask::JFileDescriptorMask |
( |
const int |
file_descriptor | ) |
|
|
inline |
◆ get() [1/2]
const fd_set* JLANG::JFileDescriptorMask::get |
( |
| ) |
const |
|
inline |
Get pointer to mask.
- Returns
- pointer to mask
Definition at line 79 of file JFileDescriptorMask.hh.
81 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 90 of file JFileDescriptorMask.hh.
92 return static_cast<fd_set*>(
this);
◆ operator&() [1/2]
const fd_set* JLANG::JFileDescriptorMask::operator& |
( |
| ) |
const |
|
inline |
◆ operator&() [2/2]
fd_set* JLANG::JFileDescriptorMask::operator& |
( |
| ) |
|
|
inline |
◆ 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 125 of file JFileDescriptorMask.hh.
◆ set() [1/2]
void JLANG::JFileDescriptorMask::set |
( |
const int |
file_descriptor | ) |
|
|
inline |
Set file descriptor.
- Parameters
-
file_descriptor | file descriptor |
Definition at line 154 of file JFileDescriptorMask.hh.
156 if (!
has(file_descriptor)) {
158 FD_SET(file_descriptor,
get());
◆ set() [2/2]
void JLANG::JFileDescriptorMask::set |
( |
const JAbstractFile & |
file | ) |
|
|
inline |
◆ reset() [2/3]
void JLANG::JFileDescriptorMask::reset |
( |
const int |
file_descriptor | ) |
|
|
inline |
Reset file descriptor.
- Parameters
-
file_descriptor | file descriptor |
Definition at line 185 of file JFileDescriptorMask.hh.
187 if (
has(file_descriptor)) {
189 FD_CLR(file_descriptor,
get());
◆ reset() [3/3]
void JLANG::JFileDescriptorMask::reset |
( |
const JAbstractFile & |
file | ) |
|
|
inline |
◆ 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 216 of file JFileDescriptorMask.hh.
218 return FD_ISSET(file_descriptor,
get());
◆ has() [2/2]
bool JLANG::JFileDescriptorMask::has |
( |
const JAbstractFile & |
file | ) |
const |
|
inline |
◆ getNumberOfFileDescriptors()
int JLANG::JFileDescriptorMask::getNumberOfFileDescriptors |
( |
| ) |
const |
|
inline |
◆ 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 250 of file JFileDescriptorMask.hh.
◆ in_avail()
Check availability of input.
This method returns true is at least one byte can be read without blocking. Following a select() call, this method overwrites the internal mask!
- Parameters
-
- Returns
- true if ready to read; else false
Definition at line 264 of file JFileDescriptorMask.hh.
◆ out_avail()
Check availability of output.
This method returns true is at least one byte can be written without blocking. Following a select() call, this method overwrites the internal mask!
- Parameters
-
- Returns
- true if ready to write; else false
Definition at line 278 of file JFileDescriptorMask.hh.
◆ MAXIMUM_FILE_DESCRIPTOR
const int JLANG::JFileDescriptorMask::MAXIMUM_FILE_DESCRIPTOR = FD_SETSIZE |
|
static |
◆ maximum_file_descriptor
int JLANG::JFileDescriptorMask::maximum_file_descriptor |
|
private |
◆ number_of_file_descriptors
int JLANG::JFileDescriptorMask::number_of_file_descriptors |
|
private |
The documentation for this class was generated from the following file: