struct GNUNET_MQ_Envelope *prev;
/**
- * Actual allocated message header,
- * usually points to the end of the containing GNUNET_MQ_Envelope
+ * Actual allocated message header.
+ * The GNUNET_MQ_Envelope header is allocated at
+ * the end of the message.
*/
struct GNUNET_MessageHeader *mh;
*/
struct GNUNET_MQ_Envelope *current_envelope;
+ /**
+ * GNUNET_YES if the sent notification was called
+ * for the current envelope.
+ */
+ int send_notification_called;
+
/**
* Map of associations, lazily allocated
*/
struct GNUNET_CONTAINER_MultiHashMap32 *assoc_map;
/**
- * Task scheduled during #GNUNET_MQ_impl_send_continue.
+ * Task scheduled during #GNUNET_MQ_impl_send_continue
+ * or #GNUNET_MQ_impl_send_in_flight
*/
- struct GNUNET_SCHEDULER_Task *continue_task;
+ struct GNUNET_SCHEDULER_Task *send_task;
/**
* Functions to call on queue destruction; kept in a DLL.
unsigned int queue_length;
/**
- * GNUNET_YES if GNUNET_MQ_impl_evict was called.
+ * GNUNET_YES if GNUNET_MQ_impl_evacuate was called.
*/
- int evict_called;
+ int evacuate_called;
};
* @param mqm the message to discard
*/
void
-GNUNET_MQ_discard (struct GNUNET_MQ_Envelope *mqm)
+GNUNET_MQ_discard (struct GNUNET_MQ_Envelope *ev)
{
- GNUNET_assert (NULL == mqm->parent_queue);
- GNUNET_free (mqm);
+ GNUNET_assert (NULL == ev->parent_queue);
+ GNUNET_free (ev);
}
}
+/**
+ * Task run to call the send notification for the next queued
+ * message, if any. Only useful for implementing message queues,
+ * results in undefined behavior if not used carefully.
+ *
+ * @param cls message queue to send the next message with
+ */
+static void
+impl_send_in_flight (void *cls)
+{
+ struct GNUNET_MQ_Handle *mq = cls;
+ struct GNUNET_MQ_Envelope *current_envelope;
+
+ mq->send_task = NULL;
+ /* call is only valid if we're actually currently sending
+ * a message */
+ current_envelope = mq->current_envelope;
+ GNUNET_assert (NULL != current_envelope);
+ /* can't call cancel from now on anymore */
+ current_envelope->parent_queue = NULL;
+ if ( (GNUNET_NO == mq->send_notification_called) &&
+ (NULL != current_envelope->sent_cb) )
+ {
+ current_envelope->sent_cb (current_envelope->sent_cls);
+ }
+ mq->send_notification_called = GNUNET_YES;
+}
+
/**
* Task run to call the send implementation for the next queued
struct GNUNET_MQ_Handle *mq = cls;
struct GNUNET_MQ_Envelope *current_envelope;
- mq->continue_task = NULL;
+ mq->send_task = NULL;
/* call is only valid if we're actually currently sending
* a message */
current_envelope = mq->current_envelope;
GNUNET_assert (NULL != current_envelope);
- current_envelope->parent_queue = NULL;
+ impl_send_in_flight (mq);
GNUNET_assert (0 < mq->queue_length);
mq->queue_length--;
if (NULL == mq->envelope_head)
GNUNET_CONTAINER_DLL_remove (mq->envelope_head,
mq->envelope_tail,
mq->current_envelope);
+ mq->send_notification_called = GNUNET_NO;
mq->send_impl (mq,
mq->current_envelope->mh,
mq->impl_state);
}
- if (NULL != current_envelope->sent_cb)
- current_envelope->sent_cb (current_envelope->sent_cls);
GNUNET_free (current_envelope);
}
void
GNUNET_MQ_impl_send_continue (struct GNUNET_MQ_Handle *mq)
{
- GNUNET_assert (NULL == mq->continue_task);
- mq->continue_task = GNUNET_SCHEDULER_add_now (&impl_send_continue,
- mq);
+ /* maybe #GNUNET_MQ_impl_send_in_flight was called? */
+ if (NULL != mq->send_task)
+ {
+ GNUNET_SCHEDULER_cancel (mq->send_task);
+ }
+ mq->send_task = GNUNET_SCHEDULER_add_now (&impl_send_continue,
+ mq);
+}
+
+
+/**
+ * Call the send notification for the current message, but do not
+ * try to send the message until #gnunet_mq_impl_send_continue
+ * is called.
+ *
+ * only useful for implementing message queues, results in undefined
+ * behavior if not used carefully.
+ *
+ * @param mq message queue to send the next message with
+ */
+void
+GNUNET_MQ_impl_send_in_flight (struct GNUNET_MQ_Handle *mq)
+{
+ GNUNET_assert (NULL == mq->send_task);
+ mq->send_task = GNUNET_SCHEDULER_add_now (&impl_send_in_flight,
+ mq);
}
uint16_t size,
uint16_t type)
{
- struct GNUNET_MQ_Envelope *mqm;
+ struct GNUNET_MQ_Envelope *ev;
- mqm = GNUNET_malloc (sizeof *mqm + size);
- mqm->mh = (struct GNUNET_MessageHeader *) &mqm[1];
- mqm->mh->size = htons (size);
- mqm->mh->type = htons (type);
+ ev = GNUNET_malloc (size + sizeof (struct GNUNET_MQ_Envelope));
+ ev->mh = (struct GNUNET_MessageHeader *) &ev[1];
+ ev->mh->size = htons (size);
+ ev->mh->type = htons (type);
if (NULL != mhp)
- *mhp = mqm->mh;
- return mqm;
+ *mhp = ev->mh;
+ return ev;
}
GNUNET_CLIENT_notify_transmit_ready_cancel (state->th);
state->th = NULL;
}
- else if (NULL != mq->continue_task)
+ else if (NULL != mq->send_task)
{
- GNUNET_SCHEDULER_cancel (mq->continue_task);
- mq->continue_task = NULL;
+ GNUNET_SCHEDULER_cancel (mq->send_task);
+ mq->send_task = NULL;
}
else
GNUNET_assert (0);
{
mq->destroy_impl (mq, mq->impl_state);
}
- if (NULL != mq->continue_task)
+ if (NULL != mq->send_task)
{
- GNUNET_SCHEDULER_cancel (mq->continue_task);
- mq->continue_task = NULL;
+ GNUNET_SCHEDULER_cancel (mq->send_task);
+ mq->send_task = NULL;
}
while (NULL != mq->envelope_head)
{
GNUNET_assert (NULL != mq);
GNUNET_assert (NULL != mq->cancel_impl);
- mq->evict_called = GNUNET_NO;
+ mq->evacuate_called = GNUNET_NO;
if (mq->current_envelope == ev)
{
GNUNET_CONTAINER_DLL_remove (mq->envelope_head,
mq->envelope_tail,
mq->current_envelope);
+ mq->send_notification_called = GNUNET_NO;
mq->send_impl (mq,
mq->current_envelope->mh,
mq->impl_state);
mq->queue_length--;
}
- if (GNUNET_YES != mq->evict_called)
+ if (GNUNET_YES != mq->evacuate_called)
{
ev->parent_queue = NULL;
ev->mh = NULL;
+ /* also frees ev */
GNUNET_free (ev);
}
}
}
-/**
- * Get the message that is currently being sent when cancellation of that
- * message is requested. Returns an opaque pointer which contains the memory
- * for the message, as well as some control data used by mq.
- *
- * This function may be called at most once in the cancel_impl
- * function of a message queue.
- *
- * Use this function to avoid copying a half-sent message.
- *
- * @param mq message queue
- * @parem msg pointer to store the message being canceled
- * @return memory block that contains the message, must be freed by the caller
- */
-void *
-GNUNET_MQ_impl_cancel_evict (struct GNUNET_MQ_Handle *mq, struct GNUNET_MessageHeader **msg)
-{
- GNUNET_assert (GNUNET_NO == mq->evict_called);
- GNUNET_assert (NULL != mq->current_envelope);
- mq->evict_called = GNUNET_YES;
- mq->current_envelope->parent_queue = NULL;
- mq->current_envelope->mh = NULL;
- *msg = mq->current_envelope->mh;
- return mq->current_envelope;
-}
-
-
/* end of mq.c */