timedWait overloads

Synopses

Declared in <bslmt_chronoutil.h>

Block on the specified primitive object of the (template parameter) PRIMITIVE type by calling its timedWait method, passing a timeout calculated from the specified absTime. absTime is an absolute time represented by a time point with respect to some epoch, which is determined by the clock associated with the time point. Return 0 on success, PRIMITIVE::e_TIMED_OUT if the absTime timeout expired, and other return values on error. The timedWait method of primitive is called only once if the clock type specified by the (template parameter) type CLOCK corresponds to the clock used by primitive, and may be called more than once otherwise. Note that error codes returned from this method, necessarily distinct from 0 and PRIMITIVE::e_TIMED_OUT, are defined by PRIMITIVE.

template<
    class PRIMITIVE,
    class CLOCK,
    class DURATION>
static
int
timedWait(
    PRIMITIVE* primitive,
    bsl::chrono::time_point<CLOCK, DURATION> const& absTime);

» more...

Block on the specified primitive object of the (template parameter) PRIMITIVE type by calling its timedWait method, passing the specified argument of the (template parameter) ARG_TYPE and a timeout calculated from the specified absTime. absTime is an absolute time represented by a time point with respect to some epoch, which is determined by the clock associated with the time point. Return 0 on success, PRIMITIVE::e_TIMED_OUT if the absTime timeout expired, and other return values on error. The timedWait method of primitive is called only once if the clock type specified by the (template parameter) type CLOCK corresponds to the clock used by primitive, and may be called more than once otherwise. Note that error codes returned from this method, necessarily distinct from 0 and PRIMITIVE::e_TIMED_OUT, are defined by PRIMITIVE.

template<
    class PRIMITIVE,
    class ARG_TYPE,
    class CLOCK,
    class DURATION>
static
int
timedWait(
    PRIMITIVE* primitive,
    ARG_TYPE* argument,
    bsl::chrono::time_point<CLOCK, DURATION> const& absTime);

» more...

Created with MrDocs