blocxx
Classes | Typedefs | Functions | Variables

BLOCXX_NAMESPACE::Select Namespace Reference

Classes

struct  SelectObject

Typedefs

typedef Array< SelectObjectSelectObjectArray

Functions

int selectRW (SelectObjectArray &selarray, UInt32 ms)
int selectRWEpoll (SelectObjectArray &selarray, const Timeout &timeout)
int selectRWPoll (SelectObjectArray &selarray, const Timeout &timeout)
int selectRWSelect (SelectObjectArray &selarray, const Timeout &timeout)
int selectRW (SelectObjectArray &selarray, const Timeout &timeout=Timeout::infinite)
 Select returns as soon as input or output is available on any of the Select_t objects that are in given array or the timeout has passed.
int select (const SelectTypeArray &selarray, UInt32 ms) BLOCXX_DEPRECATED
 Select returns as soon as input is available on any of Select_t objects that are in given array.
int select (const SelectTypeArray &selarray, const Timeout &timeout)

Variables

const int SELECT_TIMEOUT = -2
 The value returned from select when the timeout value has expired.
const int SELECT_ERROR = -1
 The value returned from select when any error occurs other than timeout.
const int SELECT_NOT_IMPLEMENTED = -4
 Used internally, but listed here to prevent conflicts.
const UInt32 INFINITE_TIMEOUT BLOCXX_DEPRECATED = ~0U
 Value that means infinite timeout.

Typedef Documentation

Definition at line 113 of file Select.hpp.


Function Documentation

BLOCXX_COMMON_API int BLOCXX_NAMESPACE::Select::select ( const SelectTypeArray &  selarray,
UInt32  ms 
)

Select returns as soon as input is available on any of Select_t objects that are in given array.

Parameters:
selarrayAn array of Select_t objects that will be used while waiting for input to become available.
msThe timeout value specified in milliseconds
Returns:
On success, the index in the selarray of the first Select_t object that input has become available on. SELECT_ERROR on error. SELECT_TIMEOUT if the given timeout value has expired.

Definition at line 490 of file Select.cpp.

References BLOCXX_NAMESPACE::Timeout::relative().

Referenced by selectRWSelect().

BLOCXX_COMMON_API int BLOCXX_NAMESPACE::Select::select ( const SelectTypeArray &  selarray,
const Timeout &  timeout 
)
BLOCXX_COMMON_API int BLOCXX_NAMESPACE::Select::selectRW ( SelectObjectArray &  selarray,
const Timeout &  timeout = Timeout::infinite 
)

Select returns as soon as input or output is available on any of the Select_t objects that are in given array or the timeout has passed.

Parameters:
selarrayAn array of Select_t objects that will be used while waiting for input or output to become available.
timeoutThe timeout.
Returns:
On success, the number of descriptors available. SELECT_ERROR on error. SELECT_TIMEOUT if the given timeout value has expired. The input and output out parameters are modified to indicate which descriptors are available.

Definition at line 467 of file Select.cpp.

References BLOCXX_ASSERT, SELECT_NOT_IMPLEMENTED, selectRWEpoll(), selectRWPoll(), and selectRWSelect().

BLOCXX_COMMON_API int BLOCXX_NAMESPACE::Select::selectRW ( SelectObjectArray &  selarray,
UInt32  ms 
)
int BLOCXX_NAMESPACE::Select::selectRWEpoll ( SelectObjectArray &  selarray,
const Timeout &  timeout 
)
int BLOCXX_NAMESPACE::Select::selectRWPoll ( SelectObjectArray &  selarray,
const Timeout &  timeout 
)
int BLOCXX_NAMESPACE::Select::selectRWSelect ( SelectObjectArray &  selarray,
const Timeout &  timeout 
)

Variable Documentation

const UInt32 INFINITE_TIMEOUT BLOCXX_NAMESPACE::Select::BLOCXX_DEPRECATED = ~0U

Value that means infinite timeout.

Definition at line 71 of file Select.hpp.

The value returned from select when any error occurs other than timeout.

Definition at line 63 of file Select.hpp.

Referenced by BLOCXX_NAMESPACE::SocketBaseImpl::connect(), BLOCXX_NAMESPACE::SelectEngine::go(), select(), selectRWEpoll(), selectRWPoll(), and selectRWSelect().

Used internally, but listed here to prevent conflicts.

Definition at line 67 of file Select.hpp.

Referenced by selectRW(), selectRWEpoll(), selectRWPoll(), and selectRWSelect().

The value returned from select when the timeout value has expired.

Definition at line 59 of file Select.hpp.

Referenced by BLOCXX_NAMESPACE::SocketBaseImpl::connect(), BLOCXX_NAMESPACE::SelectEngine::go(), selectRWEpoll(), selectRWPoll(), selectRWSelect(), and BLOCXX_NAMESPACE::SocketUtils::waitForIO().