cnet's Application Programming Interface

NAME

CNET_unused_debug_event - find a debug event, EV_DEBUG*, that does not have an associated event handler.

SYNOPSIS

#include <cnet.h> CnetEvent CNET_unused_debug_event(void);

DESCRIPTION

CNET_unused_debug_event finds (at runtime) an unused debug event - one that does not have associated event handler. This enables independent source-code files in a large protocol to find and use a debug event without interfering with the actions of other source-code files.

If the function call is successful, the returned event is not 'reserved' by cnet. It is anticipated that calls to CNET_set_handler and CNET_set_debug_string will next be made, passing the returned event as the first parameter.

RETURN VALUE

On success, one of the standard debug events, EV_DEBUG0 to EV_DEBUG4, will be returned. On failure, if there are no unused debug events, the value EV_NULL will be returned.

SEE ALSO

CNET_set_handler, and CNET_set_debug_string.