Module econfd_notif

An Erlang interface equivalent to the event notifications C-API, (documented in confd_lib_events(3)).

Version: 5.7.19

Description

An Erlang interface equivalent to the event notifications C-API, (documented in confd_lib_events(3)).

notification() = #econfd_notif_audit{} | #econfd_notif_syslog{} | #econfd_notif_commit_simple{} | #econfd_notif_commit_diff{} | #econfd_notif_user_session{} | #econfd_notif_ha{} | #econfd_notif_subagent_info{} | #econfd_notif_commit_failed{} | #econfd_notif_snmpa{} | #econfd_notif_forward_info{} | #econfd_notif_confirmed_commit{} | #econfd_notif_upgrade{} | #econfd_notif_progress{} | #econfd_notif_stream_event{} | #econfd_notif_ncs_cq_progress{} | #econfd_notif_ncs_audit_network{} | confd_heartbeat | confd_health_check | confd_reopen_logs | ncs_package_reload

Function Index

close/1	Close the event notification connection.
connect/2	Equivalent to `connect(Address, 4565, Mask)`.
connect/3	Equivalent to `connect(Address, Port, Mask, [])`.
connect/4	Connect to the notif server on host with address Address:Port.
handle_notif/1	(Deprecated.) Decode the notif message and return corresponding record depending on the type of the message.
notification_done/2	Indicate that we're done with diff processing.
notification_done/3	Indicate that we're done with notif processing.
recv/1	Equivalent to `recv(Socket, infinity)`.
recv/2	Wait for an event notification message and return corresponding record depending on the type of the message.

Function Details

close/1

close(Socket) -> Result

Socket = econfd:socket()
Result = ok | {error, econfd:error_reason()}

Close the event notification connection.

connect/2

connect(Address, Mask) -> econfd:connect_result()

Address = econfd:ip()
Mask = integer()

Equivalent to connect(Address, 4565, Mask).

connect/3

connect(Address, Port, Mask) -> econfd:connect_result()

Address = econfd:ip()
Port = non_neg_integer()
Mask = integer()

Equivalent to connect(Address, Port, Mask, []).

connect/4

connect(Address, Port, Mask, Options) -> econfd:connect_result()

Address = econfd:ip()
Port = non_neg_integer()
Mask = integer()
Options = [Option]
Option = {heartbeat_interval, integer()} | {health_check_interval, integer()} | {stream_name, atom()} | {start_time, econfd:datetime()} | {stop_time, econfd:datetime()} | {xpath_filter, binary()} | {usid, integer()} | {verbosity, 0..3}

Connect to the notif server on host with address Address:Port.

If the port is changed it must also be changed in confd.conf. The Mask argument is a bitmask made out of the bits defined in econfd.hrl as CONFD_NOTIF_XXX. If CONFD_NOTIF_HEARTBEAT and/or CONFD_NOTIF_HEALTH_CHECK is included in Mask, the corresponding desired interval (in milliseconds) must be included in the options list. If CONFD_NOTIF_STREAM_EVENT is included in Mask, 'stream_name' must be included in the options list, 'start_time'/'stop_time' option may be used for replay, 'xpath_filter' may be used for event notification filtering, and 'usid' may be given to apply AAA restrictions. To close a notification socket, use close/1.

handle_notif/1

handle_notif(Notif) -> notification()

Notif = binary() | term()

This function is deprecated: Use the function recv/2 instead.

Decode the notif message and return corresponding record depending on the type of the message.

It is the resposibility of the application to read data from the notifications socket.

notification_done/2

notification_done(Socket, Thandle) -> Result

Socket = econfd:socket()
Thandle = integer()
Result = ok | {error, econfd:error_reason()}

Indicate that we're done with diff processing.

Whenever we subscribe to ?CONFD_NOTIF_COMMIT_DIFF we must indicate to confd that we're done with the diff processing. The transaction hangs until we've done this.

notification_done/3

notification_done(Socket, Usid, NotifType) -> Result

Socket = econfd:socket()
Usid = integer()
NotifType = audit | audit_network
Result = ok | {error, econfd:error_reason()}

Indicate that we're done with notif processing.

When we subscribe to ?CONFD_NOTIF_AUDIT with ?CONFD_NOTIF_AUDIT_SYNC or to ?NCS_NOTIF_AUDIT_NETWORK with ?NCS_NOTIF_AUDIT_NETWORK_SYNC, we must indicate that we're done with the notif processing. The user-session hangs until we've done this.

recv/1

recv(Socket) -> any()

Equivalent to recv(Socket, infinity).

recv/2

recv(Socket, Timeout) -> Result

Socket = econfd:socket()
Timeout = non_neg_integer() | infinity
Result = {ok, notification()} | {error, econfd:transport_error()} | {error, econfd:error_reason()}

Wait for an event notification message and return corresponding record depending on the type of the message.

The logno element in the record is an integer. These integers can be used as an index to the function econfd_logsyms:get_logsym/1 in order to get a textual description for the event.

When recv/2 returns {error, timeout} the connection (and its event subscriptions) is still active and the application needs to call recv/2 again. But if recv/2 returns {error, Reason} the connection to ConfD is closed and all event subscriptions associated with it are cleared.

Generated by EDoc