BLOCXX_NAMESPACE::Select Namespace Reference

Classes
struct	SelectObject

Typedefs
typedef Array< SelectObject >	SelectObjectArray

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

SelectObjectArray

typedef Array<SelectObject> BLOCXX_NAMESPACE::Select::SelectObjectArray

Definition at line 113 of file Select.hpp.

Function Documentation

select() [1/2]

BLOCXX_COMMON_API int BLOCXX_NAMESPACE::Select::select	(	const SelectTypeArray &	selarray,
		const Timeout &	timeout )

Definition at line 497 of file Select.cpp.

References i, BLOCXX_NAMESPACE::operator==(), BLOCXX_NAMESPACE::Array< T >::reserve(), SELECT_ERROR, and selectRW().

select() [2/2]

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

selarray	An array of Select_t objects that will be used while waiting for input to become available.
ms	The 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::operator==(), BLOCXX_NAMESPACE::Timeout::relative(), and select().

Referenced by select(), and selectRWSelect().

selectRW() [1/2]

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

selarray	An array of Select_t objects that will be used while waiting for input or output to become available.
timeout	The 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, BLOCXX_NAMESPACE::operator==(), SELECT_NOT_IMPLEMENTED, selectRWEpoll(), selectRWPoll(), and selectRWSelect().

selectRW() [2/2]

BLOCXX_COMMON_API int BLOCXX_NAMESPACE::Select::selectRW	(	SelectObjectArray &	selarray,
		UInt32	ms )

Definition at line 92 of file Select.cpp.

References BLOCXX_NAMESPACE::operator==(), BLOCXX_NAMESPACE::Timeout::relative(), and selectRW().

Referenced by BLOCXX_NAMESPACE::SocketBaseImpl::connect(), BLOCXX_NAMESPACE::SelectEngine::go(), BLOCXX_NAMESPACE::Exec::processInputOutput(), select(), selectRW(), and BLOCXX_NAMESPACE::SocketUtils::waitForIO().

selectRWEpoll()

int BLOCXX_NAMESPACE::Select::selectRWEpoll	(	SelectObjectArray &	selarray,
		const Timeout &	timeout )

Definition at line 186 of file Select.cpp.

References BLOCXX_ASSERT, i, BLOCXX_NAMESPACE::operator==(), BLOCXX_NAMESPACE::Select::SelectObject::readAvailable, SELECT_ERROR, SELECT_NOT_IMPLEMENTED, SELECT_TIMEOUT, and BLOCXX_NAMESPACE::Thread::testCancel().

Referenced by selectRW().

selectRWPoll()

int BLOCXX_NAMESPACE::Select::selectRWPoll	(	SelectObjectArray &	selarray,
		const Timeout &	timeout )

Definition at line 274 of file Select.cpp.

References BLOCXX_ASSERT, i, BLOCXX_NAMESPACE::operator==(), SELECT_ERROR, SELECT_NOT_IMPLEMENTED, SELECT_TIMEOUT, and BLOCXX_NAMESPACE::Thread::testCancel().

Referenced by selectRW().

selectRWSelect()

int BLOCXX_NAMESPACE::Select::selectRWSelect	(	SelectObjectArray &	selarray,
		const Timeout &	timeout )

Definition at line 359 of file Select.cpp.

References BLOCXX_ASSERT, i, BLOCXX_NAMESPACE::operator==(), select(), SELECT_ERROR, SELECT_NOT_IMPLEMENTED, SELECT_TIMEOUT, and BLOCXX_NAMESPACE::Thread::testCancel().

Referenced by selectRW().

Variable Documentation

BLOCXX_DEPRECATED

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

Value that means infinite timeout.

Definition at line 71 of file Select.hpp.

SELECT_ERROR

const int BLOCXX_NAMESPACE::Select::SELECT_ERROR = -1

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(), BLOCXX_NAMESPACE::Exec::processInputOutput(), select(), selectRWEpoll(), selectRWPoll(), and selectRWSelect().

SELECT_NOT_IMPLEMENTED

const int BLOCXX_NAMESPACE::Select::SELECT_NOT_IMPLEMENTED = -4

Used internally, but listed here to prevent conflicts.

Definition at line 67 of file Select.hpp.

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

SELECT_TIMEOUT

const int BLOCXX_NAMESPACE::Select::SELECT_TIMEOUT = -2

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(), BLOCXX_NAMESPACE::Exec::processInputOutput(), selectRWEpoll(), selectRWPoll(), selectRWSelect(), and BLOCXX_NAMESPACE::SocketUtils::waitForIO().