oc_network_monitor.h File Reference

#include "oc_export.h"
#include "oc_network_events.h"
#include "oc_session_events.h"
#include "util/oc_compiler.h"

Functions
int	oc_add_network_interface_event_callback (interface_event_handler_t cb)
	Add the callback to receive change notifications for Network interface event. More...
int	oc_add_session_event_callback (session_event_handler_t cb)
	Add the callback to receive session event notifications. More...
int	oc_add_session_event_callback_v1 (session_event_handler_v1_t cb, void *user_data)
	Add the callback to receive session event notifications. More...
int	oc_remove_network_interface_event_callback (interface_event_handler_t cb)
	Remove the callback to receive change notifications for Network interface event. More...
int	oc_remove_session_event_callback (session_event_handler_t cb)
	Remove the callback to receive session event notifications. More...
int	oc_remove_session_event_callback_v1 (session_event_handler_v1_t cb, void *user_data, bool ignore_user_data)
	Remove the callback with to receive session event notifications. More...

Function Documentation

oc_add_network_interface_event_callback()

int oc_add_network_interface_event_callback

(

interface_event_handler_t

cb

)

Add the callback to receive change notifications for Network interface event.

Parameters

cb	The callback to be added. Must not be NULL.

Returns

0 on success

-1 on error

oc_add_session_event_callback()

int oc_add_session_event_callback

(

session_event_handler_t

cb

)

Add the callback to receive session event notifications.

Parameters

cb	The callback to be added. Must not be NULL.

Returns

0 on success

-1 on error

Deprecated:

replaced by oc_add_session_event_callback_v1 in v2.2.5.4

oc_add_session_event_callback_v1()

int oc_add_session_event_callback_v1	(	session_event_handler_v1_t	cb,
		void *	user_data
	)

Add the callback to receive session event notifications.

Parameters

cb	The callback to be added (cannot be NULL).
user_data	user data passed to the callback when invoked

Returns

0 on success

-1 on error

oc_remove_network_interface_event_callback()

int oc_remove_network_interface_event_callback

(

interface_event_handler_t

cb

)

Remove the callback to receive change notifications for Network interface event.

Parameters

cb	The callback to be removed. Must not be NULL.

Returns

0 on success

-1 on error

oc_remove_session_event_callback()

int oc_remove_session_event_callback

(

session_event_handler_t

cb

)

Remove the callback to receive session event notifications.

Parameters

cb	The callback to be removed. Must not be NULL.

Returns

0 on success

-1 on error

Deprecated:

replaced by oc_remove_session_event_callback_v1 in v2.2.5.4

oc_remove_session_event_callback_v1()

int oc_remove_session_event_callback_v1	(	session_event_handler_v1_t	cb,
		void *	user_data,
		bool	ignore_user_data
	)

Remove the callback with to receive session event notifications.

Parameters

cb	The callback to be removed.
user_data	user data provided to the callback by oc_add_session_event_callback_v1
ignore_user_data	ignore user_data and match only the function pointer

Returns

0 on success

OC_ERR_SESSION_EVENT_HANDLER_NOT_FOUND when no match was found

-1 other errors

See also

oc_add_session_event_callback_v1