TipcDispatcherDispatch

Name

TipcDispatcherDispatch — dispatch triggered events and exit

Synopsis

T_BOOL TipcDispatcherDispatch(dispatcher, timeout) 
T_IPC_DISPATCHER dispatcher; 
T_REAL8 timeout;

Arguments

dispatcher — the dispatcher

timeout — the amount of time to wait for triggered events

Return Values

TRUE if the dispatcher successfully dispatched events, FALSE otherwise.

Diagnostics

If TipcDispatcherDispatch fails, it returns FALSE and sets the global SmartSockets error number to one of:

T_ERR_NULL_PTR — dispatcher was null

T_ERR_VAL_INVALID — timeout was negative

T_ERR_TIMEOUT_REACHED — no events were dispatched

T_ERR_UNSUPPORTED — the current thread is not the owner of the dispatcher

Description

TipcDispatcherDispatch immediately invokes any triggered events and then exits event if timeout seconds has not elapsed. If there are no triggered events, it waits for up to timeout seconds for events to be triggered.

Caution

This function can only be called from the same thread that created the dispatcher.

Examples

This example dispatches events:

if (!TipcDispatcherDispatch(dispatcher, 1.0)) { 
  return;  /* error */ 
}