registry.h File Reference

Component Registry. More...

#include <stdint.h>
#include <cmw-cmx/common.h>

Include dependency graph for registry.h:

Functions
int	cmx_registry_discover (cmx_component_info **const components, int *const len)
	Create array with information about all CMX Components.
void	cmx_registry_format_filename (char *filename_buf, const int process_id, const char *const component_name)
int	cmx_registry_parse_filename (const char *filename_buf, int *const process_id, char *const component_name)
int	cmx_registry_cleanup ()
	Clean up orphaned cmx components.

---

Detailed Description

Component Registry.

---

Function Documentation

int cmx_registry_cleanup

(

)

Clean up orphaned cmx components.

Iterate through the main-registry and delete all components where the process-id is not related to a currently running process.

Returns:

• E_CMX_SUCCESS
• see cmx_registry_discover()

int cmx_registry_discover	(	cmx_component_info **const	components,
		int *const	len
	)

Create array with information about all CMX Components.

The caller is obligated to call free() on the 'components' pointer if returncode is E_CMX_SUCCESS.

Parameters:

	components	may be NULL
	len	number of cmx components on this machine

Returns:

• E_CMX_SUCCESS
• E_CMX_INVALID_ARGUMENT
• E_CMX_OPERATION_FAILED (access to /dev/shm failed)
• E_CMX_OUT_OF_MEMORY (allocation of array failed)

void cmx_registry_format_filename	(	char *	filename_buf,
		const int	process_id,
		const char *const	component_name
	)

Parameters:

	filename_buf	char buffer of size PATH_MAX (at least: 5 + (int_max in _10) + CMX_NAME_SZ)
	process_id
	component_name

int cmx_registry_parse_filename	(	const char *	filename_buf,
		int *const	process_id,
		char *const	component_name
	)

Parameters:

	filename_buf
	process_id	not null
	component_name	not null (>=CMX_NAME_SZ)

Returns:

• CMX_TRUE parse succeeded
• CMX_FALSE parse failed