nagios4/docs/api-incompat3to4.dox
2017-05-19 23:37:19 +02:00

74 lines
3.5 KiB
Plaintext

/**@page api_incompat3to4 API incompatibilities between Nagios 3 and 4
A list of API incompatibilities between Nagios 3 and 4.
[TOC]
@section globalvars Global Variables
@li event_list_{high,low} and event_list_{high,low}_tail are no more.
Instead there is "squeue_t *nagios_squeue", which is a single queue
to handle all timed events.
@li last_command_check, command_check_interval, external_command_buffer
and external_command_buffer_slots are no more.
@li check_result_list is no more
@li passive_check_result_list and passive_check_result_list_tail are no
more.
@section datastructures Data Structures
@li All primary objects have been given an 'id' field, which can be
used to store additional data about each object, or mark them in
bitmaps, or...
@li Container-ish pointers have been removed pretty much everywhere in
favour of testable libraries with specific lookup properties and
containers. This means 'next_hash' etc no longer exist in any object.
The 'next' pointers in primary objects still remain, but you should
avoid using them in favour of iterating over objects using the object
arrays.
@li next and prev have been removed from timed_event. It's no longer
possible to sanely loop over all queued elements, since the squeue
library keeps its types opaque. Adding an "squeue_foreach()" thing
would be as simple as running a breadth-first search in the pqueue
library that drives the squeue implementation.
@li The scheduled_downtime data type now has start_event and
stop_event.
@li nebstruct_program_status_data no longer has a last_command_check
var.
@li The passive_service_check data type is no more.
@li The data type circular_buffer has been removed.
@li The host object's notify_on_down, notify_on_up, notify_on_blablah
variables have been replaced with a single "notification_options" field
instead, which is a small hand-managed bitmask of the states we should
notify on, based on 1 << current_state.
@li As per above, with flap_detection_options
@li As per above, with stalking_options
@li As per the three above, with services
@li As per above, with dependencies which now have a "failure_options"
field instead of multiple "fail_on_foo" fields.
@li As per above with escalations, which now have an
"escalation_options" field instead of multiple "escalate on foo" fields.
@section functions Functions
@li Event queue management functions have been significantly altered
to match the new scheduling queue implementation. add_event(),
remove_event(), reschedule_event() and schedule_new_event() are the
primary ones.
@li submit_external_command() and submit_raw_external_command() have
been removed, as has check_for_external_commands().
@li All functions handling adding and removing objects to circular
buffers or other types of linked lists used for searching have been
removed.
@li The *host*_3x() functions are gone. They have been replaced with
versions without the _3x suffix.
@li run_sync_host_check_3x() is gone. perform_on_demand_host_check(),
which previously only called run_sync_host_check_3x(), now does
something sensible instead of calling out to a single helper.
@li Using the 'struct host_struct *foo' form of type-naming has been
obsoleted and will no longer work. Use 'struct host' instead.
@li Use of typedef'ed typenames for non-opaque structures is now
deprecated. The typedef's will be removed in Nagios 5, and modules
that wish to continue using them after that will have to add them
themselves. The new preferred form is 'struct host *foo', which
clearly shows that we're dealing with a non-opaque type.
*/