Object Mapper

Functions
Eldbus_Object *	eldbus_object_get (Eldbus_Connection *conn, const char *bus, const char *path)
	Get an object of the given bus and path.
Eldbus_Object *	eldbus_object_ref (Eldbus_Object *obj)
	Increase object reference.
void	eldbus_object_unref (Eldbus_Object *obj)
	Decrease object reference. If reference == 0 object will be freed and all its children.
void	eldbus_object_free_cb_add (Eldbus_Object *obj, Eldbus_Free_Cb cb, const void *data)
	Add a callback function to be called when object will be freed.
void	eldbus_object_free_cb_del (Eldbus_Object *obj, Eldbus_Free_Cb cb, const void *data)
	Remove callback registered in eldbus_object_free_cb_add().
void	eldbus_object_event_callback_add (Eldbus_Object *obj, Eldbus_Object_Event_Type type, Eldbus_Object_Event_Cb cb, const void *cb_data)
	Add a callback function to be called when an event of the specified type occurs.
void	eldbus_object_event_callback_del (Eldbus_Object *obj, Eldbus_Object_Event_Type type, Eldbus_Object_Event_Cb cb, const void *cb_data)
	Remove callback registered in eldbus_object_event_callback_add().
Eldbus_Connection *	eldbus_object_connection_get (const Eldbus_Object *obj)
const char *	eldbus_object_bus_name_get (const Eldbus_Object *obj)
const char *	eldbus_object_path_get (const Eldbus_Object *obj)
Eldbus_Pending *	eldbus_object_send (Eldbus_Object *obj, Eldbus_Message *msg, Eldbus_Message_Cb cb, const void *cb_data, double timeout)
	Send a message.
Eldbus_Signal_Handler *	eldbus_object_signal_handler_add (Eldbus_Object *obj, const char *interface, const char *member, Eldbus_Signal_Cb cb, const void *cb_data)
	Add a signal handler.
Eldbus_Message *	eldbus_object_method_call_new (Eldbus_Object *obj, const char *interface, const char *member)
	Call a dbus method on the Eldbus_Object.
Typedefs
typedef struct _Eldbus_Object_Event_Interface_Added	Eldbus_Object_Event_Interface_Added
typedef struct _Eldbus_Object_Event_Interface_Removed	Eldbus_Object_Event_Interface_Removed
typedef struct _Eldbus_Object_Event_Property_Changed	Eldbus_Object_Event_Property_Changed
typedef struct _Eldbus_Object_Event_Property_Removed	Eldbus_Object_Event_Property_Removed
typedef void(*	Eldbus_Object_Event_Cb )(void *data, Eldbus_Object *obj, void *event_info)

---

Typedef Documentation

Eldbus_Object_Event_Cb

Callback that will be called when an Eldbus_Object event happens.

Parameters:

data	Context data.
obj	The Eldbus_Object.
event_info	Information about the event that triggered the callback.

Eldbus_Object_Event_Interface_Added

Structure used with the ELDBUS_OBJECT_EVENT_IFACE_ADDED event.

Eldbus_Object_Event_Interface_Removed

Structure used with the ELDBUS_OBJECT_EVENT_IFACE_REMOVED event.

Eldbus_Object_Event_Property_Changed

Structure used with the ELDBUS_OBJECT_EVENT_PROPERTY_CHANGED event.

Eldbus_Object_Event_Property_Removed

Structure used with the ELDBUS_OBJECT_EVENT_PROPERTY_REMOVED event.

---

Enumeration Type Documentation

enum Eldbus_Object_Event_Type

An enumeration containing several Eldbus_Object event types.

Enumerator:

ELDBUS_OBJECT_EVENT_IFACE_ADDED	a parent path must have a ObjectManager interface
ELDBUS_OBJECT_EVENT_IFACE_REMOVED	a parent path must have a ObjectManager interface
ELDBUS_OBJECT_EVENT_PROPERTY_CHANGED	a property has changes
ELDBUS_OBJECT_EVENT_PROPERTY_REMOVED	a property was removed
ELDBUS_OBJECT_EVENT_LAST	sentinel, not a real event type

---

Function Documentation

const char* eldbus_object_bus_name_get

(

const Eldbus_Object *

obj

)

Deprecated:

Deprecated since 4.0. Get the name associated with a Eldbus_Object.

Parameters:

obj	The Eldbus_Object.

Returns:

A string corresponding to the Eldbus_Object name.

Since :

3.0

Eldbus_Connection* eldbus_object_connection_get

(

const Eldbus_Object *

obj

)

Deprecated:

Deprecated since 4.0. Get the Eldbus_Connection object associated with a Eldbus_Object.

Parameters:

obj	The Eldbus_Object.

Returns:

The corresponding Eldbus_Connection object.

Since :

3.0

void eldbus_object_event_callback_add	(	Eldbus_Object *	obj,
		Eldbus_Object_Event_Type	type,
		Eldbus_Object_Event_Cb	cb,
		const void *	cb_data
	)

Add a callback function to be called when an event of the specified type occurs.

Deprecated:

Deprecated since 4.0.

Parameters:

obj	The Eldbus_Object on which to register a callback.
type	The type of the event.
cb	The callback to call.
cb_data	The data to pass to the callback.

Since :

3.0

void eldbus_object_event_callback_del	(	Eldbus_Object *	obj,
		Eldbus_Object_Event_Type	type,
		Eldbus_Object_Event_Cb	cb,
		const void *	cb_data
	)

Remove callback registered in eldbus_object_event_callback_add().

Deprecated:

Deprecated since 4.0.

Parameters:

obj	The Eldbus_Object.
type	The type of the event.
cb	The callback to call.
cb_data	The data to pass to the callback.

Since :

3.0

void eldbus_object_free_cb_add	(	Eldbus_Object *	obj,
		Eldbus_Free_Cb	cb,
		const void *	data
	)

Add a callback function to be called when object will be freed.

Deprecated:

Deprecated since 4.0.

Parameters:

obj	object that you want to monitor
cb	callback that will be executed
data	passed to callback

Since :

3.0

void eldbus_object_free_cb_del	(	Eldbus_Object *	obj,
		Eldbus_Free_Cb	cb,
		const void *	data
	)

Remove callback registered in eldbus_object_free_cb_add().

Deprecated:

Deprecated since 4.0.

Parameters:

obj	Object monitored.
cb	Callback that was registered.
data	Data that was passed to callback.

Since :

3.0

Eldbus_Object* eldbus_object_get	(	Eldbus_Connection *	conn,
		const char *	bus,
		const char *	path
	)

Get an object of the given bus and path.

Deprecated:

Deprecated since 4.0.

Parameters:

conn	connection where object belongs
bus	name of bus or unique-id of who listens for calls of this object
path	object path of this object

Returns:

The corresponding Eldbus_Object.

Since :

3.0

Eldbus_Message* eldbus_object_method_call_new	(	Eldbus_Object *	obj,
		const char *	interface,
		const char *	member
	)

Call a dbus method on the Eldbus_Object.

Deprecated:

Deprecated since 4.0.

Parameters:

obj	The Eldbus_Object on which to call the method.
interface	Interface name.
member	Name of the method to be called.

Returns:

a new Eldbus_Message, free with eldbus_message_unref()

Since :

3.0

const char* eldbus_object_path_get

(

const Eldbus_Object *

obj

)

Deprecated:

Deprecated since 4.0. Get the path associated with a Eldbus_Object.

Parameters:

obj	The Eldbus_Object.

Returns:

A string corresponding to the Eldbus_Object path.

Since :

3.0

Eldbus_Object* eldbus_object_ref

(

Eldbus_Object *

obj

)

Increase object reference.

Deprecated:

Deprecated since 4.0.

Parameters:

obj	An Eldbus_Object.

Returns:

The same Eldbus_Object with an increased refcount.

Since :

3.0

Eldbus_Pending* eldbus_object_send	(	Eldbus_Object *	obj,
		Eldbus_Message *	msg,
		Eldbus_Message_Cb	cb,
		const void *	cb_data,
		double	timeout
	)

Send a message.

Deprecated:

Deprecated since 4.0.

Parameters:

obj	the msg will be sent in connection to this object
msg	message that will be sent
cb	if msg is a method call a callback should be passed to be executed when a response arrives
cb_data	data passed to callback
timeout	timeout in milliseconds, -1 to default internal value or ELDBUS_TIMEOUT_INFINITE for no timeout

Returns:

A Eldbus_Pending object.

Since :

3.0

Eldbus_Signal_Handler* eldbus_object_signal_handler_add	(	Eldbus_Object *	obj,
		const char *	interface,
		const char *	member,
		Eldbus_Signal_Cb	cb,
		const void *	cb_data
	)

Add a signal handler.

Deprecated:

Deprecated since 4.0.

Parameters:

obj	where the signal is emitted
interface	of the signal
member	name of the signal
cb	callback that will be called when this signal is received
cb_data	data that will be passed to callback

Returns:

A listener to the desired signal.

Since :

3.0

void eldbus_object_unref

(

Eldbus_Object *

obj

)

Decrease object reference. If reference == 0 object will be freed and all its children.

Deprecated:

Deprecated since 4.0.

Parameters:

obj	An Eldbus_Object.

Since :

3.0