iCall::PerpetualHandler

Introduced : BIG-IP_v11.3.0
The PerpetualHandler interface allows you to create or delete perpetual handlers. These handlers contain a set of objects called subscriptions; a subscription registers interest in an event of a certain name. Each subscription also may optionally include a list of filters to further reduce the set of events that come in. For example, if a subscription exists to an event indicating that a pool member goes down, then the filters might be set up to restrict interest to pool members in a certain subnet. When a perpetual handler is created a Tcl script is started. It will receive and be able to handle any events that match at least one of the handler&aposs subscriptions. Perpetual handlers have an advantage over triggered handlers (see the TriggeredHandler interface) in that they can save state. However, more than one event may be handled in parallel by a triggered handler at the same time.

Methods

Method Description Introduced
add_filter Add the specified filters to the specified subscriptions. The initial match algorithms for these filters will all be MATCH_ALGORITHM_EXACT. BIG-IP_v11.3.0
add_subscription Add new subscriptions to perpetual handlers. BIG-IP_v11.3.0
create Creates new perpetual handlers. BIG-IP_v11.3.0
delete_all_handlers Deletes all user-defined (non-root) perpetual handlers. BIG-IP_v11.3.0
delete_handler Deletes the specified perpetual handlers. BIG-IP_v11.3.0
get_description Gets the descriptions for the specified perpetual handlers. BIG-IP_v11.3.0
get_filter Gets a list of filter names for the specified subscriptions. BIG-IP_v11.3.0
get_filter_match_algorithm Get the match algorithms for the specified filters. BIG-IP_v11.3.0
get_filter_value Get the values for the specified filters. BIG-IP_v11.3.0
get_handler_state Gets the states for the specified perpetual handlers. BIG-IP_v11.3.0
get_list Gets the list of perpetual handlers. BIG-IP_v11.3.0
get_script Gets the scripts for the specified perpetual handlers. BIG-IP_v11.3.0
get_subscription Gets a list of subscriptions. BIG-IP_v11.3.0
get_subscription_event Get the event names from the specified subscriptions. BIG-IP_v11.3.0
get_version Gets the version information for this interface. BIG-IP_v11.3.0
remove_all_filters Remove all filters from the given subscriptions. BIG-IP_v11.3.0
remove_all_subscriptions Remove all subscriptions from perpetual handlers. BIG-IP_v11.3.0
remove_filter Remove filters from the given subscriptions. BIG-IP_v11.3.0
remove_subscription Remove subscriptions from perpetual handlers. BIG-IP_v11.3.0
set_description Sets the description for the specified perpetual handlers. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.3.0
set_filter_match_algorithm Set the match algorithms for the specified filters. BIG-IP_v11.3.0
set_filter_value Set the values for the specified filters. BIG-IP_v11.3.0
set_handler_state Sets the states for the specified perpetual handlers. This field describes whether the handler is running and accepting events. BIG-IP_v11.3.0
set_script Sets the script for the specified perpetual handlers. This is the name of a Tcl script that will be run when an event to which this handler subscribes fires. BIG-IP_v11.3.0
set_subscription_event Set the event names for the specified subscriptions. BIG-IP_v11.3.0

Structures

Structure Description

Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.