gobj_topic_desc()

Retrieves the description of a topic in the given hgobj. The function returns a JSON object containing metadata about the specified topic.

C

Prototype

PUBLIC json_t *gobj_topic_desc(
    hgobj gobj,
    const char *topic_name
);

Parameters

Key	Type	Description
gobj	hgobj	The hgobj instance representing the object that manages the topic.
topic_name	const char *	The name of the topic whose description is to be retrieved.

---

Return Value

Returns a JSON object containing the topic description. If the hgobj is NULL or destroyed, or if the function is not implemented, it returns NULL.

Notes

This function checks if the hgobj is valid before proceeding. If the method mt_topic_desc is not defined in the hgobj’s gclass, an error is logged and NULL is returned.

JS

Prototype

// Not applicable in JS

Python

Prototype

# Not applicable in Python

Examples

C

// TODO C examples

JS

// TODO JS examples

Python

# TODO Python examples