ptree_register_handler(3picltre) [opensolaris man page]
ptree_register_handler(3PICLTREE) PICL Plug-In Library Functions ptree_register_handler(3PICLTREE) NAME
ptree_register_handler - register a handler for the event SYNOPSIS
cc [ flag... ] file... -lpicltree [ library... ] #include <picltree.h> int ptree_register_handler(const char *ename, void (*evt_handler)(const char *ename, const void *earg, size_t size, void *cookie), void *cookie); DESCRIPTION
The ptree_register_handler() function registers an event handler for a PICL event. The argument ename specifies the name of the PICL event for which to register the handler. The argument evt_handler specifies the event handler function. The argument cookie is a pointer to call- er-specific data to be passed as an argument to the event handler when it is invoked. The event handler function must be defined as void evt_handler(const char *ename, const void *earg, size_t size, void *cookie) where, ename, earg, size, and cookie are the arguments passed to the event handler when it is invoked. The argument ename is the PICL event name for which the handler is invoked. The arguments earg and size gives the pointer to the event argument buffer and its size, respec- tively. The argument cookie is the pointer to the caller specific data registered with the handler. The arguments ename and earg point to buffers that are transient and shall not be modified by the event handler or reused after the event handler finishes execution. The PICL framework invokes the event handlers in the order in which they were registered when dispatching an event. If the event handler execution order is required to be the same as the plug-in dependency order, then a plug-in should register its handlers from its init func- tion. The handlers that do not have any ordering dependencies on other plug-in handlers can be registered at any time. The registered handler may be called at any time after this function is called. RETURN VALUES
Upon successful completion, 0 is returned. On failure, a non-negative integer is returned to indicate an error and the handler is not reg- istered. ERRORS
PICL_INVALIDARG Invalid argument PICL_FAILURE General system failure ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Evolving | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
ptree_unregister_handler(3PICLTREE), attributes(5) SunOS 5.11 1 Aug 2000 ptree_register_handler(3PICLTREE)
Check Out this Related Man Page
ddi_add_event_handler(9F) Kernel Functions for Drivers ddi_add_event_handler(9F) NAME
ddi_add_event_handler - add an NDI event service callback handler SYNOPSIS
#include <sys/dditypes.h> #include <sys/sunddi.h> int ddi_add_event_handler(dev_info_t *dip, ddi_eventcookie_t cookie, void (*handler)(dev_info_t *, ddi_eventcookie_t, void *, void *), void *arg, ddi_registration_id_t *id); INTERFACE LEVEL
Solaris DDI specific (Solaris DDI). PARAMETERS
dev_info_t *dip Device node registering the callback. ddi_eventcookie_t cookie Cookie returned from call to ddi_get_eventcookie(9F). void (*handler)(dev_info_t *, ddi_eventcookie_t, void *, void *) Callback handler responsible for handling an NDI event service notification. void *arg Pointer to opaque data supplied by the caller. Typically, this would be a pointer to the driver's softstate structure. ddi_registration_id_t *id Pointer to registration ID where a unique registration id will be returned. Registration ID must be saved and used when calling ddi_remove_event_handler(9F) to unregister a callback. DESCRIPTION
The ddi_add_event_handler() function adds a callback handler to be invoked in the face of the event specifed by cookie. The process of adding a callback handler is also known as subscribing to an event. Upon successful subscription, the handler will be invoked by the system when the event occurs. The handler can be unregistered by using ddi_remove_event_handler(9F). An instance of a driver can register multiple handlers for an event or a single handler for multiple events. Callback order is not defined and should assumed to be random. The routine handler will be invoked with the following arguments: dev_info_t *dip Device node requesting the notification. ddi_eventcookie_t cookie Structure describing event that occurred. void *arg Opaque data pointer provided, by the driver, during callback registration. void *impl_data Pointer to event specific data defined by the framework which invokes the callback function. RETURN VALUES
DDI_SUCCESS Callback handler registered successfully. DDI_FAILURE Failed to register callback handler. Possible reasons include lack of resources or a bad cookie. CONTEXT
The ddi_add_event_handler() and handler() function can be called from user and kernel contexts only. ATTRIBUTES
See attributes(5) for a description of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Stability Level |Evolving | +-----------------------------+-----------------------------+ SEE ALSO
attributes(5), ddi_get_eventcookie(9F), ddi_remove_event_handler(9F) Writing Device Drivers NOTES
Drivers must remove all registered callback handlers for a device instance by calling ddi_remove_event_handler(9F) before detach completes. SunOS 5.10 62 Nov 2003 ddi_add_event_handler(9F)