Tizen Native API  4.0
Proxy

Functions

Eldbus_Proxyeldbus_proxy_get (Eldbus_Object *obj, const char *interface)
 Get a proxy of the following interface name in a Eldbus_Object.
Eldbus_Proxyeldbus_proxy_ref (Eldbus_Proxy *proxy)
 Increase proxy reference.
void eldbus_proxy_unref (Eldbus_Proxy *proxy)
 Decrease proxy reference. If reference == 0 proxy will be freed and all your children.
Eldbus_Objecteldbus_proxy_object_get (const Eldbus_Proxy *proxy)
 Get the Eldbus_Object associated with a proxy object.
const char * eldbus_proxy_interface_get (const Eldbus_Proxy *proxy)
 Get the interface name associated with a proxy object.
void eldbus_proxy_data_set (Eldbus_Proxy *proxy, const char *key, const void *data)
 Set data to an Eldbus_Proxy object.
void * eldbus_proxy_data_get (const Eldbus_Proxy *proxy, const char *key)
 Get data of an Eldbus_Proxy object.
void * eldbus_proxy_data_del (Eldbus_Proxy *proxy, const char *key)
 Delete data of an Eldbus_Proxy object.
void eldbus_proxy_free_cb_add (Eldbus_Proxy *proxy, Eldbus_Free_Cb cb, const void *data)
 Add a callback function to be called when an event of the type passed occurs.
void eldbus_proxy_free_cb_del (Eldbus_Proxy *proxy, Eldbus_Free_Cb cb, const void *data)
 Remove callback registered in eldbus_proxy_free_cb_add().
Eldbus_Messageeldbus_proxy_method_call_new (Eldbus_Proxy *proxy, const char *member)
 Constructs a new message to invoke a method on a remote interface.
Eldbus_Pendingeldbus_proxy_send (Eldbus_Proxy *proxy, Eldbus_Message *msg, Eldbus_Message_Cb cb, const void *cb_data, double timeout)
 Send a message.
Eldbus_Messageeldbus_proxy_send_and_block (Eldbus_Proxy *proxy, Eldbus_Message *msg, double timeout)
 Send a message and block while waiting for the reply.
Eldbus_Pendingeldbus_proxy_call (Eldbus_Proxy *proxy, const char *member, Eldbus_Message_Cb cb, const void *cb_data, double timeout, const char *signature,...)
 Call a method in proxy. Send a method call to interface that proxy belong with data.
Eldbus_Pendingeldbus_proxy_vcall (Eldbus_Proxy *proxy, const char *member, Eldbus_Message_Cb cb, const void *cb_data, double timeout, const char *signature, va_list ap)
 Call a method in proxy. Send a method call to interface that proxy belong with data.
Eldbus_Signal_Handlereldbus_proxy_signal_handler_add (Eldbus_Proxy *proxy, const char *member, Eldbus_Signal_Cb cb, const void *cb_data)
 Add a signal handler.
void eldbus_proxy_event_callback_add (Eldbus_Proxy *proxy, Eldbus_Proxy_Event_Type type, Eldbus_Proxy_Event_Cb cb, const void *cb_data)
 Add a callback function to be called when occurs a event of the type passed.
void eldbus_proxy_event_callback_del (Eldbus_Proxy *proxy, Eldbus_Proxy_Event_Type type, Eldbus_Proxy_Event_Cb cb, const void *cb_data)
 Remove callback registered in eldbus_proxy_event_callback_add().

Typedefs

typedef struct
_Eldbus_Proxy_Event_Property_Changed 
Eldbus_Proxy_Event_Property_Changed
typedef struct
_Eldbus_Proxy_Event_Property_Loaded 
Eldbus_Proxy_Event_Property_Loaded
typedef struct
_Eldbus_Proxy_Event_Property_Removed 
Eldbus_Proxy_Event_Property_Removed
typedef void(* Eldbus_Proxy_Event_Cb )(void *data, Eldbus_Proxy *proxy, void *event_info)

Typedef Documentation

A callback called when an event occurs.

Parameters:
dataThe data passed by the caller.
proxyThe Eldbus_Proxy object.
event_infoInformation on the event that triggered the callback.

A structure used when ELDBUS_PROXY_EVENT_PROPERTY_CHANGED event is received.

A structure used when ELDBUS_PROXY_EVENT_PROPERTY_LOADED event is received.

A structure used when ELDBUS_PROXY_EVENT_PROPERTY_REMOVED event is received.


Enumeration Type Documentation

An enumeration containing proxy event types.

Enumerator:
ELDBUS_PROXY_EVENT_PROPERTY_CHANGED 

a property has changed

ELDBUS_PROXY_EVENT_PROPERTY_REMOVED 

a property was removed

ELDBUS_PROXY_EVENT_LAST 

sentinel, not a real event type


Function Documentation

Eldbus_Pending* eldbus_proxy_call ( Eldbus_Proxy proxy,
const char *  member,
Eldbus_Message_Cb  cb,
const void *  cb_data,
double  timeout,
const char *  signature,
  ... 
)

Call a method in proxy. Send a method call to interface that proxy belong with data.

Deprecated:
Deprecated since 4.0.
Parameters:
proxy
membermethod name
cbif msg is a method call a callback should be passed to be execute when response arrive
cb_datadata passed to callback
timeouttimeout in milliseconds, -1 to default internal value or ELDBUS_TIMEOUT_INFINITE for no timeout
signatureof data that will be send
...data value
Returns:
A Eldbus_Pending object on the sent message.
Note:
This function only support basic type to complex types use eldbus_message_iter_* functions.
Since :
3.0
void* eldbus_proxy_data_del ( Eldbus_Proxy proxy,
const char *  key 
)

Delete data of an Eldbus_Proxy object.

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy on which to delete the data.
keyThe string to which the data is associated.
Since :
3.0
void* eldbus_proxy_data_get ( const Eldbus_Proxy proxy,
const char *  key 
)

Get data of an Eldbus_Proxy object.

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy on which to get the data.
keyThe string to which the data is associated.
Returns:
The data set to the proxy object associated with the provided key.
Since :
3.0
void eldbus_proxy_data_set ( Eldbus_Proxy proxy,
const char *  key,
const void *  data 
)

Set data to an Eldbus_Proxy object.

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy on which to set the data.
keyA string to which the data will be associated.
dataThe data to set to the proxy object.
Since :
3.0
void eldbus_proxy_event_callback_add ( Eldbus_Proxy proxy,
Eldbus_Proxy_Event_Type  type,
Eldbus_Proxy_Event_Cb  cb,
const void *  cb_data 
)

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

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy object.
typeThe type of the event to register an callback on.
cbThe callback function to register.
cb_dataThe data to pass to the callback.
Since :
3.0
void eldbus_proxy_event_callback_del ( Eldbus_Proxy proxy,
Eldbus_Proxy_Event_Type  type,
Eldbus_Proxy_Event_Cb  cb,
const void *  cb_data 
)

Remove callback registered in eldbus_proxy_event_callback_add().

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy object.
typeThe type of the event the callback was registered on.
cbThe callback function to delete.
cb_dataThe data passed to the callback.
Since :
3.0
void eldbus_proxy_free_cb_add ( Eldbus_Proxy proxy,
Eldbus_Free_Cb  cb,
const void *  data 
)

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

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy on which to add the callback.
cbThe callback to add.
dataThe data to pass to the callback.
Since :
3.0
void eldbus_proxy_free_cb_del ( Eldbus_Proxy proxy,
Eldbus_Free_Cb  cb,
const void *  data 
)

Remove callback registered in eldbus_proxy_free_cb_add().

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy on which to delete the callback.
cbThe callback to delete.
dataThe data passed to the callback.
Since :
3.0
Eldbus_Proxy* eldbus_proxy_get ( Eldbus_Object obj,
const char *  interface 
)

Get a proxy of the following interface name in a Eldbus_Object.

Deprecated:
Deprecated since 4.0.
Parameters:
objThe Eldbus_Object on which to do the query.
interfaceThe interface name of the proxy.
Returns:
The corresponding Eldbus_Proxy object.
Since :
3.0
const char* eldbus_proxy_interface_get ( const Eldbus_Proxy proxy)

Get the interface name associated with a proxy object.

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy on which to do the query.
Returns:
The string corresponding to the interface name.
Since :
3.0
Eldbus_Message* eldbus_proxy_method_call_new ( Eldbus_Proxy proxy,
const char *  member 
)

Constructs a new message to invoke a method on a remote interface.

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy on which to call the method.
memberThe name of the method to invoke.
Returns:
An Eldbus_Message object.
Since :
3.0

Get the Eldbus_Object associated with a proxy object.

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy on which to do the query.
Returns:
The corresponding Eldbus_Object.
Since :
3.0

Increase proxy reference.

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy on which to increase the refcount.
Returns:
The Eldbus_Proxy with an increased refcount.
Since :
3.0
Eldbus_Pending* eldbus_proxy_send ( Eldbus_Proxy proxy,
Eldbus_Message msg,
Eldbus_Message_Cb  cb,
const void *  cb_data,
double  timeout 
)

Send a message.

Deprecated:
Deprecated since 4.0.
Parameters:
proxythe msg will be send in connection that proxy belongs
msgmessage that will be send
cbif msg is a method call a callback should be passed
cb_datadata passed to callback
timeouttimeout in milliseconds, -1 to default internal value or ELDBUS_TIMEOUT_INFINITE for no timeout
Returns:
A Eldbus_Pending object on the sent message.
Since :
3.0
Eldbus_Message* eldbus_proxy_send_and_block ( Eldbus_Proxy proxy,
Eldbus_Message msg,
double  timeout 
)

Send a message and block while waiting for the reply.

Deprecated:
Deprecated since 4.0.
Parameters:
proxythe msg will be send in connection that proxy belongs
msgmessage that will be send
timeouttimeout in milliseconds, -1 to default internal value or ELDBUS_TIMEOUT_INFINITE for no timeout
Returns:
The reply message, error message or NULL. The returned Eldbus_Message need to be unref after read.
Since (EFL) :
1.13
Since :
3.0
Eldbus_Signal_Handler* eldbus_proxy_signal_handler_add ( Eldbus_Proxy proxy,
const char *  member,
Eldbus_Signal_Cb  cb,
const void *  cb_data 
)

Add a signal handler.

Deprecated:
Deprecated since 4.0.
Parameters:
proxyinterface where the signal is emitted
membername of the signal
cbcallback that will be called when this signal is received
cb_datadata that will be passed to callback
Returns:
A listener to the desired signal.
Since :
3.0
void eldbus_proxy_unref ( Eldbus_Proxy proxy)

Decrease proxy reference. If reference == 0 proxy will be freed and all your children.

Deprecated:
Deprecated since 4.0.
Parameters:
proxyThe Eldbus_Proxy on which to decrease the refcount.
Since :
3.0
Eldbus_Pending* eldbus_proxy_vcall ( Eldbus_Proxy proxy,
const char *  member,
Eldbus_Message_Cb  cb,
const void *  cb_data,
double  timeout,
const char *  signature,
va_list  ap 
)

Call a method in proxy. Send a method call to interface that proxy belong with data.

Deprecated:
Deprecated since 4.0.
Parameters:
proxy
membermethod name
cbcallback that will be called when response arrive.
cb_datadata passed to callback
timeouttimeout in milliseconds, -1 to default internal value or ELDBUS_TIMEOUT_INFINITE for no timeout
signatureof data that will be send
apva_list of data value
Returns:
A Eldbus_Pending object on the sent message.
Note:
This function only support basic type to complex types use eldbus_message_iter_* functions.
Since :
3.0