RPMsg Name Service Component

This section describes the RPMsg Name Service component that allows: More...

Overview

This section describes the RPMsg Name Service component that allows:

• Transmission of named endpoint creation and deletion announcement.
• Reception of the announcements.

Classes
struct	rpmsg_ns_callback_data
	Nameservice callback data structure. More...
struct	rpmsg_ns_handle
	Nameservice context structure. More...
struct	rpmsg_ns_static_context
	Static nameservice context container. More...

Macros
#define	RL_NS_EPT_ADDR
	Name service endpoint address.

Typedefs
typedef void(*	rpmsg_ns_new_ept_cb) (uint32_t new_ept, const char *new_ept_name, uint32_t flags, void *user_data)
	New endpoint NS callback function type.

Enumerations
enum	rpmsg_ns_flags {   RL_NS_CREATE ,   RL_NS_DESTROY }
	Flags used during name service announcement.

Functions
rpmsg_ns_handle	rpmsg_ns_bind (struct rpmsg_lite_instance *rpmsg_lite_dev, rpmsg_ns_new_ept_cb app_cb, void *user_data)
	Registers application nameservice callback.
int32_t	rpmsg_ns_unbind (struct rpmsg_lite_instance *rpmsg_lite_dev, rpmsg_ns_handle handle)
	Unregisters application nameservice callback and cleans up.
int32_t	rpmsg_ns_announce (struct rpmsg_lite_instance *rpmsg_lite_dev, struct rpmsg_lite_endpoint *new_ept, const char *ept_name, uint32_t flags)
	Sends name service announcement to remote device.

---

Class Documentation

rpmsg_ns_callback_data

struct rpmsg_ns_callback_data

Nameservice callback data structure.

This structure holds the callback function and user data used for nameservice notifications.

Class Members
rpmsg_ns_new_ept_cb	cb
void *	user_data

rpmsg_ns_context

struct rpmsg_ns_context

Nameservice context structure.

This structure contains the nameservice endpoint and callback data used for nameservice announcement handling.

Class Members
struct rpmsg_lite_endpoint *	ept
struct rpmsg_ns_callback_data *	cb_ctxt

rpmsg_ns_static_context_container

struct rpmsg_ns_static_context_container

Static nameservice context container.

This structure provides memory for all nameservice contexts when static API is used (RL_USE_STATIC_API).

Class Members
struct rpmsg_lite_ept_static_context	ept_ctxt
struct rpmsg_ns_callback_data	cb_ctxt
struct rpmsg_ns_context	ns_ctxt

Function Documentation

rpmsg_ns_bind()

rpmsg_ns_handle rpmsg_ns_bind	(	struct rpmsg_lite_instance *	rpmsg_lite_dev,
		rpmsg_ns_new_ept_cb	app_cb,
		void *	user_data
	)

Registers application nameservice callback.

Parameters

rpmsg_lite_dev	RPMsg-Lite instance
app_cb	Application nameservice callback
user_data	Application nameservice callback data

Returns

RL_NULL on error, NameService handle on success.

rpmsg_ns_unbind()

int32_t rpmsg_ns_unbind	(	struct rpmsg_lite_instance *	rpmsg_lite_dev,
		rpmsg_ns_handle	handle
	)

Unregisters application nameservice callback and cleans up.

Parameters

rpmsg_lite_dev	RPMsg-Lite instance
handle	NameService handle

Returns

Status of function execution, RL_SUCCESS on success.

rpmsg_ns_announce()

int32_t rpmsg_ns_announce	(	struct rpmsg_lite_instance *	rpmsg_lite_dev,
		struct rpmsg_lite_endpoint *	new_ept,
		const char *	ept_name,
		uint32_t	flags
	)

Sends name service announcement to remote device.

Parameters

rpmsg_lite_dev	RPMsg-Lite instance
new_ept	New endpoint to announce
ept_name	Name for the announced endpoint
flags	Channel creation/deletion flags

Returns

Status of function execution, RL_SUCCESS on success