Groups Server Callbacks

Collaboration diagram for Groups Server Callbacks:

Functions
void	tr_groups_server_init_cb (void)
	Callback fires when groups server cluster is initialized.
zb_bool_t	tr_groups_server_add_group_cb (zb_uint8_t endpoint, zb_uint16_t group_id, zb_char_t *group_name)
	Callback that fires on receipt of groups server cluster add group command.
zb_bool_t	tr_groups_server_add_group_if_identifying_cb (zb_bool_t is_identifying, zb_uint8_t endpoint, zb_uint16_t group_id, zb_char_t *group_name)
	Callback that fires on receipt of groups server cluster add group if identifying command.
zb_bool_t	tr_groups_server_view_group_cb (zb_uint8_t endpoint, zb_uint16_t group_id, zb_char_t *group_name)
	Callback that fires on receipt of groups server cluster view group command.
zb_bool_t	tr_groups_server_get_group_membership_cb (zb_uint8_t endpoint, zb_uint8_t group_count, zb_uint16_t *group_id_list)
	Callback that fires on receipt of groups server cluster get group membership command.
zb_bool_t	tr_groups_server_remove_group_cb (zb_uint8_t endpoint, zb_uint16_t group_id)
	Callback that fires on receipt of groups server cluster remove group command.
zb_bool_t	tr_groups_server_remove_all_groups_cb (zb_uint8_t endpoint)
	Callback that fires on receipt of groups server cluster remove all groups command.

Detailed Description

---

---

Function Documentation

tr_groups_server_add_group_cb()

zb_bool_t tr_groups_server_add_group_cb	(	zb_uint8_t	endpoint,
		zb_uint16_t	group_id,
		zb_char_t *	group_name )

Callback that fires on receipt of groups server cluster add group command.

Parameters

endpoint	endpoint that received the command
group_id	group id being added
group_name	optional group name being added

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_add_group_if_identifying_cb()

zb_bool_t tr_groups_server_add_group_if_identifying_cb	(	zb_bool_t	is_identifying,
		zb_uint8_t	endpoint,
		zb_uint16_t	group_id,
		zb_char_t *	group_name )

Callback that fires on receipt of groups server cluster add group if identifying command.

Parameters

is_identifying	ZB_TRUE if actively identifying, ZB_FALSE otherwise
endpoint	endpoint that received the command
group_id	group id being added
group_name	optional group name being added

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_get_group_membership_cb()

zb_bool_t tr_groups_server_get_group_membership_cb	(	zb_uint8_t	endpoint,
		zb_uint8_t	group_count,
		zb_uint16_t *	group_id_list )

Callback that fires on receipt of groups server cluster get group membership command.

Parameters

endpoint	endpoint that received the command
group_count	number of groups being checked
group_id_list	list of group ids being checked

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_init_cb()

void tr_groups_server_init_cb

(

void

)

Callback fires when groups server cluster is initialized.

tr_groups_server_remove_all_groups_cb()

zb_bool_t tr_groups_server_remove_all_groups_cb

(

zb_uint8_t

endpoint

)

Callback that fires on receipt of groups server cluster remove all groups command.

Parameters

endpoint

endpoint that received the command

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_remove_group_cb()

zb_bool_t tr_groups_server_remove_group_cb	(	zb_uint8_t	endpoint,
		zb_uint16_t	group_id )

Callback that fires on receipt of groups server cluster remove group command.

Parameters

endpoint	endpoint that received the command
group_id	group id to be removed

Returns

ZB_FALSE to allow framework to continue processing the command

tr_groups_server_view_group_cb()

zb_bool_t tr_groups_server_view_group_cb	(	zb_uint8_t	endpoint,
		zb_uint16_t	group_id,
		zb_char_t *	group_name )

Callback that fires on receipt of groups server cluster view group command.

Parameters

endpoint	endpoint that received the command
group_id	group id being checked
group_name	group name that should be sent in the response

Returns

ZB_FALSE to allow framework to continue processing the command