rapi_dispatch()--Dispatch the RAPI message-handling routine
Syntax
#include <rapi.h> int rapi_dispatch(void)
Service program name: QSYS/QTOQRAPI
Default public authority: *EXCLUDE
Threadsafe: Yes
The rapi-dispatch() API dispatches the RAPI message-handling routine defined in the rapi_session() call. The application should call this routine whenever a read event is signaled on a file descriptor returned by the rapi_getfd() API call. This routine may be called at any time, but generally it has no effect unless there is a pending event.
Calling this routine may result in one or more RAPI message-handling routines to the application from any of the Open API sessions known to this instance of the library.
Parameters
None.
Authorities
None.
Return Value
Returns 0 if successful.
RAPI error code if it fails.
Error Conditions
- [RAPI_ERR_NORSVP]
RSVP server was not detected. Make sure the RSVP server is running.
- [RAPI_ERR_MEMFULL]
Unable to allocate memory. Check the system memory status.
- [RAPI_ERR_INVAL]
Error detected in the RSVP specifications being handled by the RAPI message-handling routine.
Usage Notes
The rapi_session() API must be called to create a valid session before this API is called. This API typically is called to respond to an event received on the file descriptor returned by the rapi_getfd() API call.
Related Information
For a description of the RSVP protocol, see RFC 2205 on the RFC Pages.
Complete documentation of the RAPI APIs can be found at The Open Group.
API introduced: V5R1