diffusion_change_roles_params_with_filter_s Struct Reference

Structure supplied when issuing a diffusion_change_roles_with_filter call. More...

#include <client-control.h>

Data Fields
const char *	filter
	Identifies the set of client sessions for which the change will be applied.
const SET_T *	roles_to_remove
	A set of roles to be removed from the session.
const SET_T *	roles_to_add
	A set of roles to be added to the session.
change_roles_with_filter_cb	on_roles_changed
	Callback when the roles have been successfully changed.
ERROR_HANDLER_T	on_error
	Callback to handle errors. Can be NULL.
DISCARD_HANDLER_T	on_discard
	Callback to handle discards. Can be NULL.
void *	context
	User supplied context. Can be NULL.

Detailed Description

Structure supplied when issuing a diffusion_change_roles_with_filter call.

Field Documentation

filter

const char* diffusion_change_roles_params_with_filter_s::filter

Identifies the set of client sessions for which the change will be applied.

For details on how to specify session filters see session.h.

roles_to_add

const SET_T* diffusion_change_roles_params_with_filter_s::roles_to_add

A set of roles to be added to the session.

If one or more roles from the list are already assigned, they are ignored.

roles_to_remove

const SET_T* diffusion_change_roles_params_with_filter_s::roles_to_remove

A set of roles to be removed from the session.

If one or more roles from the list are not currently assigned, they are ignored.

---

The documentation for this struct was generated from the following file:

• main/public/include/features/client-control.h