10:55 a.m.
From: Inaky Perez-Gonzalez <inaky.perez-gonzalez(a)intel.com>
This introduces the ability to cancel a pending SMS message,
accessible via an internal API and over a D-Bus wrapper.
Sending a note to the network to cancel an in-transit message is not
yet implemented.
Note the test case code requires follow up commits that propagate the
message's state changes over D-Bus.
---
src/sms.c | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 55 insertions(+), 0 deletions(-)
diff --git a/src/sms.c b/src/sms.c
index 638492e..40b4cf1 100644
--- a/src/sms.c
+++ b/src/sms.c
@@ -527,6 +527,20 @@ static void __ofono_sms_tx_state_set(struct tx_queue_entry *entry,
}
+
+static void sms_msg_cancel(struct tx_queue_entry *);
+/*
+ * Note that the D-Bus specific cleanups are taken care by the
+ * sms_msg_dbus_destroy() callback passed in dbus_sms_msg_send().
+ */
+static DBusMessage *dbus_sms_msg_cancel(
+ DBusConnection * conn, DBusMessage *msg, void *data)
+{
+ struct tx_queue_entry *sms_msg = data;
+ sms_msg_cancel(sms_msg);
+ return dbus_message_new_method_return(msg);
+}
+
/*
* D-Bus SMS Message interface
*
@@ -536,6 +550,8 @@ static void __ofono_sms_tx_state_set(struct tx_queue_entry *entry,
static
GDBusMethodTable sms_msg_methods[] = {
+ { "Cancel", "", "",
+ dbus_sms_msg_cancel, 0 },
{ }
};
@@ -581,6 +597,11 @@ static void tx_finished(const struct ofono_error *error, int mr, void
*data)
gboolean ok = error->type == OFONO_ERROR_TYPE_NO_ERROR;
DBG("tx_finished");
+ /*
+ * Queue is empty? Messages might have been cancelled.
+ */
+ if (entry == NULL)
+ return;
if (ok == FALSE) {
if (!(entry->flags & OFONO_SMS_SUBMIT_FLAG_RETRY)) {
@@ -854,6 +875,40 @@ struct tx_queue_entry *sms_msg_send(
return sms_msg;
}
+/**
+ * Cancel a pending SMS message
+ *
+ * @sms_msg: message to cancel
+ *
+ * This function cancels a message that is pending or being
+ * actively transmitted. Note that after this function returns, the
+ * @sms_msg handle is no longer valid.
+ *
+ * \internal
+ *
+ * There is no need to cancel the calling of tx_next() by
+ * g_timeout_add() scheduled in sms_msg_send(). The rationale behind
+ * this is that the tx_next() function is scheduled to go over the
+ * list of messages in the @sms object, so it might have been
+ * scheduled for other messages also rather than just for this one
+ * @sms_msg. By the time it gets to run, it might see the list empty
+ * or see other messages, but @sms_msg won't be there.
+ */
+static void sms_msg_cancel(struct tx_queue_entry *sms_msg)
+{
+ struct ofono_sms *sms = sms_msg->sms_mgr;
+ DBG("%s (%p)\n", __func__, sms_msg);
+
+ if (sms_msg->state == OFONO_SMS_TX_ST_QUEUED)
+ g_queue_remove(sms->txq, sms_msg);
+ else if (sms_msg->state == OFONO_SMS_TX_ST_WSR)
+ g_queue_remove(sms->tx_wsrq, sms_msg);
+
+ ofono_sms_tx_state_set(sms_msg, OFONO_SMS_TX_ST_CANCELING);
+ ofono_sms_tx_state_set(sms_msg, OFONO_SMS_TX_ST_CANCELLED);
+ tx_queue_entry_destroy(sms_msg);
+}
+
/*
* Send a PropertyChange signal when the state changes
*
--
1.6.6.1