reply_internal
[message_internal]

Collaboration diagram for reply_internal:

---

Detailed Description

Module for manage EasyDbus Reply_msg objects internal

TO COMPLETE

See also:

skeleton module for functions to use for insert args on methods. In particular must be used EASYDBUS_ET_REPLY as event type value.

Reply_msg Meta Information

Contact:

Daniele Rondina aka Ge@ru <geaaru@gmail.com>

Status:

EasyDbus Core Library

License:

GPL

Contributor(s):

• Daniele Rondina aka Ge@ru <geaaru@gmail.com>

Functions
int	easydbus_reply_build_error (struct EasyDbus_method *method, const char *error_msg)
	Create Error reply.
int	easydbus_reply_build_struct (struct EasyDbus_method *method, DBusMessage *reply)
	Create EasyDbus_reply for an EasyDbus_method object from a DBusMessage reply.
DBusMessage *	easydbus_reply_create_msg (struct EasyDbus_core *core, struct EasyDbus_reply *reply, DBusMessage *method_msg)
	Create DBusMessage for reply.
int	easydbus_reply_send (struct EasyDbus_core *core, DBusMessage *method_msg, struct EasyDbus_reply *reply)
	Send reply on DBus bus.
int	easydbus_reply_send_error (struct EasyDbus_core *core, DBusMessage *msg, char *error_name, char *error_string)
	Send error reply.

---

Function Documentation

int easydbus_reply_build_error	(	struct EasyDbus_method *	method,
		const char *	error_msg
	)

Create Error reply.

Parameters:

	method	EasyDbus_method object pointer where is created error reply for user.
	error_msg	string with error message.

Returns:

-1 error

0 ok

For internal use only.

Definition at line 286 of file reply.c.

References easydbus_add_string_param_to_skeleton(), EASYDBUS_ET_FAILURE, EASYDBUS_ET_REPLY, easydbus_reply_create_skeleton(), easydbus_reply_free_skeleton(), EasyDbus_method::reply, and EasyDbus_reply::type.

Referenced by easydbus_send_method_withReply_Blocking().

{
   struct EasyDbus_reply *reply_foruser = NULL;

   reply_foruser = easydbus_reply_create_skeleton ();
   if (!reply_foruser)
      return -1;

   if (easydbus_add_string_param_to_skeleton
       (EASYDBUS_ET_REPLY, reply_foruser, (char *) error_msg))
      goto out_of_memory;

   reply_foruser->type = EASYDBUS_ET_FAILURE;
   method->reply = reply_foruser;

   return 0;
 out_of_memory:
   if (reply_foruser)
      easydbus_reply_free_skeleton (reply_foruser);
   return -1;
}

Here is the call graph for this function:

int easydbus_reply_build_struct	(	struct EasyDbus_method *	method,
		DBusMessage *	reply
	)

Create EasyDbus_reply for an EasyDbus_method object from a DBusMessage reply.

Parameters:

	method	EasyDbus_method object pointer
	reply	DBusMessage with reply data

Returns:

0 ok

-1 error

For internal use only.

Definition at line 319 of file reply.c.

References easydbus_build_skeleton_data(), EASYDBUS_ET_INVALID, EASYDBUS_ET_REPLY, easydbus_reply_create_skeleton(), easydbus_reply_free_skeleton(), easydbus_reply_set_interface(), easydbus_reply_set_path(), EasyDbusDebug, EasyDbus_method::reply, and EasyDbus_reply::type.

Referenced by easydbus_send_method_withReply_Blocking().

{
   struct EasyDbus_reply *reply_foruser = NULL;
   const char *temp = NULL;
   int type_msg = 0;

   reply_foruser = easydbus_reply_create_skeleton ();

   if (!reply_foruser)
      return -1;

   temp = dbus_message_get_path (reply);
   /* see of manage case where path == NULL */
   //if (temp == NULL) goto out_of_memory_error;

   if (temp)
      if (easydbus_reply_set_path (reply_foruser, temp))
         goto out_of_memory_error;

   temp = dbus_message_get_interface (reply);
   /* see of manage case where path == NULL */
   //if (temp == NULL) goto out_of_memory_error;

   if (temp)
      if (easydbus_reply_set_interface (reply_foruser,
                                        temp))
         goto out_of_memory_error;

   type_msg = dbus_message_get_type (reply);
   if (type_msg == DBUS_MESSAGE_TYPE_METHOD_RETURN)
      reply_foruser->type = EASYDBUS_ET_REPLY;
   else
      reply_foruser->type = EASYDBUS_ET_INVALID;

   easydbus_build_skeleton_data (reply, EASYDBUS_ET_REPLY,
                                 reply_foruser);

   method->reply = reply_foruser;
   EasyDbusDebug ("Created reply object");
   return 0;

out_of_memory_error:

   if (reply_foruser)
      easydbus_reply_free_skeleton (reply_foruser);

   return -1;
}

Here is the call graph for this function:

DBusMessage* easydbus_reply_create_msg	(	struct EasyDbus_core *	core,
		struct EasyDbus_reply *	reply,
		DBusMessage *	method_msg
	)			[inline]

Create DBusMessage for reply.

For internal use only.

Parameters:

	core	EasyDbus_core object pointer
	method_msg	DBusMessage of message that must be replied
	reply	EasyDbus_reply object pointer.

Returns:

NULL on error

DBusMessage object pointer for reply.

Todo:

optimize this function and manage of errors.

Definition at line 188 of file reply.c.

References add_elems_to_msg(), EasyDbus_reply::args, EASYDBUS_ELTYPE_STRING, EASYDBUS_ET_FAILURE, EASYDBUS_ET_REPLY, EasyDbus_reply::first, EasyDbus_elem::string, EasyDbus_elem::type, and EasyDbus_reply::type.

Referenced by easydbus_reply_send().

{
   DBusMessage *msg = NULL;

   if (reply->type == EASYDBUS_ET_REPLY) {
      /* create msg */
      msg = dbus_message_new_method_return (method_msg);
   }
   else if (reply->type == EASYDBUS_ET_FAILURE) {
      if (reply->args == 1 &&
          reply->first->type == EASYDBUS_ELTYPE_STRING) {
         msg = dbus_message_new_error (method_msg,
                                       DBUS_ERROR_FAILED,
                                       (const char *) reply->first->
                                       payload.string);
      }
   }

   if (msg && 
       /* add method data if there are */
       (reply->args && reply->type == EASYDBUS_ET_REPLY))
      add_elems_to_msg (msg, reply->first);

   return msg;
}

Here is the call graph for this function:

int easydbus_reply_send	(	struct EasyDbus_core *	core,
		DBusMessage *	method_msg,
		struct EasyDbus_reply *	reply
	)

Send reply on DBus bus.

For internal use only.

Parameters:

	core	EasyDbus_core object pointer
	method_msg	DBusMessage of message that must be replied
	reply	EasyDbus_reply object pointer.

Returns:

-1 error

0 ok

Definition at line 151 of file reply.c.

References easydbus_message_send(), easydbus_reply_create_msg(), and EasyDbusDebug.

Referenced by easydbus_introspect_filter_func(), and easydbus_obj_path_msg_function().

{
   DBusMessage *msg = NULL;
   int ret = -1;

   if (!reply || !method_msg || !core) {
      EasyDbusDebug ("Error from input params");
      return -1;
   }

   msg = easydbus_reply_create_msg (core, reply, method_msg);

   if (msg &&
       !easydbus_message_send (core, msg, 1, NULL))
      ret = 0;

   if (msg)
      dbus_message_unref (msg);

   return ret;
}

Here is the call graph for this function:

int easydbus_reply_send_error	(	struct EasyDbus_core *	core,
		DBusMessage *	msg,
		char *	error_name,
		char *	error_string
	)

Send error reply.

For internal use only.

Parameters:

	core	pointer to EasyDbus_core object
	msg	DBusMessage that needed error reply.
	error_name	Error name
	error_string	Error string

Todo:

see on dbus-specification syntax for error name string.

Returns:

-1 error

0 ok

Definition at line 64 of file reply.c.

References easydbus_message_send(), and EasyDbusDebug.

Referenced by easydbus_introspect_filter_func(), and easydbus_obj_path_msg_function().

{
   DBusMessage *error = NULL;

   if (!core || !msg || !error_name || !error_string) {
      EasyDbusDebug ("Error from input params");
      return -1;
   }

   error = dbus_message_new_error (msg,
                                   DBUS_ERROR_FAILED,
                                   (const char *) error_string);

   if (!error)
      return -1;

   if (easydbus_message_send (core, error, 1, NULL)) {
      dbus_message_unref (error);
      return -1;
   }
   dbus_message_unref (error);
   return 0;
}

Here is the call graph for this function:

---