#define DEBUG_CLIENT GNUNET_NO
-
/**
* How often do we re-try tranmsitting requests before giving up?
* Note that if we succeeded transmitting a request but failed to read
* a response, we do NOT re-try.
*/
-#define MAX_ATTEMPTS 10
+#define MAX_ATTEMPTS 50
/**
struct GNUNET_CONNECTION_TransmitHandle *th;
/**
- * Timeout.
+ * If we are re-trying and are delaying to do so,
+ * handle to the scheduled task managing the delay.
*/
- struct GNUNET_TIME_Absolute timeout;
+ GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
/**
- * If we are re-trying and are delaying to do so,
- * handle to the scheduled task managing the delay.
+ * Timeout for the operation overall.
*/
- GNUNET_SCHEDULER_TaskIdentifier task;
+ struct GNUNET_TIME_Absolute timeout;
/**
* Number of bytes requested.
};
+/**
+ * Context for processing
+ * "GNUNET_CLIENT_transmit_and_get_response" requests.
+ */
+struct TransmitGetResponseContext
+{
+ /**
+ * Client handle.
+ */
+ struct GNUNET_CLIENT_Connection *sock;
+
+ /**
+ * Message to transmit; do not free, allocated
+ * right after this struct.
+ */
+ const struct GNUNET_MessageHeader *hdr;
+
+ /**
+ * Timeout to use.
+ */
+ struct GNUNET_TIME_Absolute timeout;
+
+ /**
+ * Function to call when done.
+ */
+ GNUNET_CLIENT_MessageHandler rn;
+
+ /**
+ * Closure for "rn".
+ */
+ void *rn_cls;
+};
/**
* Struct to refer to a GNUnet TCP connection.
*/
char *service_name;
+ /**
+ * Context of a transmit_and_get_response operation, NULL
+ * if no such operation is pending.
+ */
+ struct TransmitGetResponseContext *tag;
+
/**
* Handler for current receiver task.
*/
*/
GNUNET_SCHEDULER_Task test_cb;
+ /**
+ * Deadline for calling 'test_cb'.
+ */
+ struct GNUNET_TIME_Absolute test_deadline;
+
+ /**
+ * If we are re-trying and are delaying to do so,
+ * handle to the scheduled task managing the delay.
+ */
+ GNUNET_SCHEDULER_TaskIdentifier receive_task;
+
/**
* Closure for test_cb (NULL unless in service_test)
*/
*/
struct GNUNET_TIME_Absolute receive_timeout;
+ /**
+ * Current value for our incremental back-off (for
+ * connect re-tries).
+ */
+ struct GNUNET_TIME_Relative back_off;
+
/**
* Number of bytes in received_buf that are valid.
*/
/**
* Are we currently busy doing receive-processing?
- * GNUNET_YES if so, GNUNET_NO if not, GNUNET_SYSERR
- * if the handle should be destroyed as soon as the
- * receive processing is done.
+ * GNUNET_YES if so, GNUNET_NO if not.
*/
int in_receive;
+ /**
+ * Are we ignoring shutdown signals?
+ */
+ int ignore_shutdown;
+
};
ret->sched = sched;
ret->service_name = GNUNET_strdup (service_name);
ret->cfg = GNUNET_CONFIGURATION_dup (cfg);
+ ret->back_off = GNUNET_TIME_UNIT_MILLISECONDS;
return ret;
}
/**
- * Receiver task has completed, free rest of client
- * data structures.
+ * Configure this connection to ignore shutdown signals.
+ *
+ * @param h client handle
+ * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
*/
-static void
-finish_cleanup (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+void
+GNUNET_CLIENT_ignore_shutdown (struct GNUNET_CLIENT_Connection *h,
+ int do_ignore)
{
- struct GNUNET_CLIENT_Connection *sock = cls;
-
- if (sock->th != NULL)
- GNUNET_CLIENT_notify_transmit_ready_cancel (sock->th);
- GNUNET_array_grow (sock->received_buf, sock->received_size, 0);
- GNUNET_free (sock->service_name);
- GNUNET_CONFIGURATION_destroy (sock->cfg);
- GNUNET_free (sock);
+ h->ignore_shutdown = do_ignore;
+ if (h->sock != NULL)
+ GNUNET_CONNECTION_ignore_shutdown (h->sock,
+ do_ignore);
}
* *NOT* be called, not even with a NULL message). Any pending
* transmission request will also be cancelled UNLESS the callback for
* the transmission request has already been called, in which case the
- * transmission is guaranteed to complete before the socket is fully
- * destroyed.
+ * transmission 'finish_pending_write' argument determines whether or
+ * not the write is guaranteed to complete before the socket is fully
+ * destroyed (unless, of course, there is an error with the server in
+ * which case the message may still be lost).
*
+ * @param finish_pending_write should a transmission already passed to the
+ * handle be completed?
* @param sock handle to the service connection
*/
void
-GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *sock)
+GNUNET_CLIENT_disconnect (struct GNUNET_CLIENT_Connection *sock,
+ int finish_pending_write)
{
GNUNET_assert (sock->sock != NULL);
- GNUNET_CONNECTION_destroy (sock->sock);
+ if (sock->in_receive == GNUNET_YES)
+ {
+ GNUNET_CONNECTION_receive_cancel (sock->sock);
+ sock->in_receive = GNUNET_NO;
+ }
+ GNUNET_CONNECTION_destroy (sock->sock, finish_pending_write);
sock->sock = NULL;
+ if (sock->tag != NULL)
+ {
+ GNUNET_free (sock->tag);
+ sock->tag = NULL;
+ }
sock->receiver_handler = NULL;
- if (sock->in_receive == GNUNET_YES)
- sock->in_receive = GNUNET_SYSERR;
- else
- GNUNET_SCHEDULER_add_after (sock->sched,
- GNUNET_SCHEDULER_NO_TASK,
- &finish_cleanup, sock);
+ if (sock->th != NULL)
+ GNUNET_CLIENT_notify_transmit_ready_cancel (sock->th);
+ if (sock->receive_task != GNUNET_SCHEDULER_NO_TASK)
+ {
+ GNUNET_SCHEDULER_cancel (sock->sched, sock->receive_task);
+ sock->receive_task = GNUNET_SCHEDULER_NO_TASK;
+ }
+ GNUNET_array_grow (sock->received_buf, sock->received_size, 0);
+ GNUNET_free (sock->service_name);
+ GNUNET_CONFIGURATION_destroy (sock->cfg);
+ GNUNET_free (sock);
}
{
struct GNUNET_CLIENT_Connection *conn = cls;
struct GNUNET_TIME_Relative remaining;
+ GNUNET_CLIENT_MessageHandler receive_handler;
+ void *receive_handler_cls;
GNUNET_assert (conn->msg_complete == GNUNET_NO);
- if (GNUNET_SYSERR == conn->in_receive)
- GNUNET_SCHEDULER_add_after (conn->sched,
- GNUNET_SCHEDULER_NO_TASK,
- &finish_cleanup, conn);
conn->in_receive = GNUNET_NO;
if ((available == 0) || (conn->sock == NULL) || (errCode != 0))
{
/* signal timeout! */
- if (conn->receiver_handler != NULL)
+ if (NULL != (receive_handler = conn->receiver_handler))
{
- conn->receiver_handler (conn->receiver_handler_cls, NULL);
+ receive_handler_cls = conn->receiver_handler_cls;
conn->receiver_handler = NULL;
+ receive_handler (receive_handler_cls, NULL);
}
return;
}
/**
* Continuation to call the receive callback.
+ *
+ * @param cls our handle to the client connection
+ * @param tc scheduler context
*/
static void
-receive_task (void *scls, const struct GNUNET_SCHEDULER_TaskContext *tc)
+receive_task (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
{
- struct GNUNET_CLIENT_Connection *sock = scls;
+ struct GNUNET_CLIENT_Connection *sock = cls;
GNUNET_CLIENT_MessageHandler handler = sock->receiver_handler;
const struct GNUNET_MessageHeader *cmsg =
(const struct GNUNET_MessageHeader *) sock->received_buf;
- void *cls = sock->receiver_handler_cls;
+ void *handler_cls = sock->receiver_handler_cls;
uint16_t msize = ntohs (cmsg->size);
char mbuf[msize];
struct GNUNET_MessageHeader *msg = (struct GNUNET_MessageHeader *) mbuf;
- if (GNUNET_SYSERR == sock->in_receive)
- GNUNET_SCHEDULER_add_after (sock->sched,
- GNUNET_SCHEDULER_NO_TASK,
- &finish_cleanup, sock);
- sock->in_receive = GNUNET_NO;
+ sock->receive_task = GNUNET_SCHEDULER_NO_TASK;
GNUNET_assert (GNUNET_YES == sock->msg_complete);
GNUNET_assert (sock->received_pos >= msize);
memcpy (msg, cmsg, msize);
sock->receiver_handler = NULL;
check_complete (sock);
if (handler != NULL)
- handler (cls, msg);
+ handler (handler_cls, msg);
}
sock->receiver_handler = handler;
sock->receiver_handler_cls = handler_cls;
sock->receive_timeout = GNUNET_TIME_relative_to_absolute (timeout);
- sock->in_receive = GNUNET_YES;
if (GNUNET_YES == sock->msg_complete)
- GNUNET_SCHEDULER_add_after (sock->sched,
- GNUNET_SCHEDULER_NO_TASK,
- &receive_task, sock);
+ {
+ sock->receive_task = GNUNET_SCHEDULER_add_after (sock->sched,
+ GNUNET_SCHEDULER_NO_TASK,
+ &receive_task, sock);
+ }
else
- GNUNET_CONNECTION_receive (sock->sock,
- GNUNET_SERVER_MAX_MESSAGE_SIZE,
- timeout, &receive_helper, sock);
-}
-
-
-/**
- * If possible, write a shutdown message to the target
- * buffer and destroy the client connection.
- *
- * @param cls the "struct GNUNET_CLIENT_Connection" to destroy
- * @param size number of bytes available in buf
- * @param buf NULL on error, otherwise target buffer
- * @return number of bytes written to buf
- */
-static size_t
-write_shutdown (void *cls, size_t size, void *buf)
-{
- struct GNUNET_MessageHeader *msg;
- struct GNUNET_CLIENT_Connection *sock = cls;
-
- GNUNET_CLIENT_disconnect (sock);
- if (size < sizeof (struct GNUNET_MessageHeader))
{
- GNUNET_log (GNUNET_ERROR_TYPE_INFO,
- _("Failed to transmit shutdown request to client.\n"));
- return 0; /* client disconnected */
+ sock->in_receive = GNUNET_YES;
+ GNUNET_CONNECTION_receive (sock->sock,
+ GNUNET_SERVER_MAX_MESSAGE_SIZE,
+ timeout, &receive_helper, sock);
}
- msg = (struct GNUNET_MessageHeader *) buf;
- msg->type = htons (GNUNET_MESSAGE_TYPE_SHUTDOWN);
- msg->size = htons (sizeof (struct GNUNET_MessageHeader));
- return sizeof (struct GNUNET_MessageHeader);
-}
-
-
-/**
- * Request that the service should shutdown.
- * Afterwards, the connection should be disconnected.
- *
- * @param sock the socket connected to the service
- */
-void
-GNUNET_CLIENT_service_shutdown (struct GNUNET_CLIENT_Connection *sock)
-{
- GNUNET_CONNECTION_notify_transmit_ready (sock->sock,
- sizeof (struct
- GNUNET_MessageHeader),
- GNUNET_TIME_UNIT_FOREVER_REL,
- &write_shutdown, sock);
}
{
service_test_error (conn->sched, conn->test_cb, conn->test_cb_cls);
}
- GNUNET_CLIENT_disconnect (conn);
+ GNUNET_CLIENT_disconnect (conn, GNUNET_NO);
}
static size_t
write_test (void *cls, size_t size, void *buf)
{
+ struct GNUNET_CLIENT_Connection *conn = cls;
struct GNUNET_MessageHeader *msg;
if (size < sizeof (struct GNUNET_MessageHeader))
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
_("Failure to transmit TEST request.\n"));
#endif
+ service_test_error (conn->sched, conn->test_cb, conn->test_cb_cls);
+ GNUNET_CLIENT_disconnect (conn, GNUNET_NO);
return 0; /* client disconnected */
}
#if DEBUG_CLIENT
- GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, _("Transmitting TEST request.\n"));
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ "Transmitting `%s' request.\n", "TEST");
#endif
msg = (struct GNUNET_MessageHeader *) buf;
msg->type = htons (GNUNET_MESSAGE_TYPE_TEST);
msg->size = htons (sizeof (struct GNUNET_MessageHeader));
+ GNUNET_CLIENT_receive (conn,
+ &confirm_handler,
+ conn,
+ GNUNET_TIME_absolute_get_remaining (conn->test_deadline));
return sizeof (struct GNUNET_MessageHeader);
}
}
conn->test_cb = task;
conn->test_cb_cls = task_cls;
- if (NULL ==
- GNUNET_CONNECTION_notify_transmit_ready (conn->sock,
- sizeof (struct
- GNUNET_MessageHeader),
- timeout, &write_test, NULL))
+ conn->test_deadline = GNUNET_TIME_relative_to_absolute (timeout);
+
+ if (NULL == GNUNET_CLIENT_notify_transmit_ready (conn,
+ sizeof (struct GNUNET_MessageHeader),
+ timeout,
+ GNUNET_YES,
+ &write_test, conn))
{
GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
_("Failure to transmit request to service `%s'\n"),
service);
service_test_error (sched, task, task_cls);
- GNUNET_CLIENT_disconnect (conn);
+ GNUNET_CLIENT_disconnect (conn, GNUNET_NO);
return;
}
- GNUNET_CLIENT_receive (conn, &confirm_handler, conn, timeout);
}
static size_t client_notify (void *cls, size_t size, void *buf);
-
/**
* This task is run if we should re-try connection to the
* service after a while.
{
struct GNUNET_CLIENT_TransmitHandle *th = cls;
- th->task = GNUNET_SCHEDULER_NO_TASK;
+ th->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
+ if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
+ {
+#if DEBUG_CLIENT
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ "Transmission failed due to shutdown.\n");
+#endif
+ th->sock->th = NULL;
+ th->notify (th->notify_cls, 0, NULL);
+ GNUNET_free (th);
+ return;
+ }
th->th = GNUNET_CONNECTION_notify_transmit_ready (th->sock->sock,
th->size,
GNUNET_TIME_absolute_get_remaining
/**
- * Connection notifies us about failure or success of
- * a transmission request. Either pass it on to our
- * user or, if possible, retry.
+ * Connection notifies us about failure or success of a transmission
+ * request. Either pass it on to our user or, if possible, retry.
*
* @param cls our "struct GNUNET_CLIENT_TransmissionHandle"
* @param size number of bytes available for transmission
{
delay = GNUNET_TIME_absolute_get_remaining (th->timeout);
delay.value /= 2;
- if ((GNUNET_YES != th->auto_retry) ||
- (0 == --th->attempts_left) || (delay.value < 1))
+ if ( (0 != (GNUNET_SCHEDULER_REASON_SHUTDOWN & GNUNET_SCHEDULER_get_reason (th->sock->sched))) ||
+ (GNUNET_YES != th->auto_retry) ||
+ (0 == --th->attempts_left) ||
+ (delay.value < 1) )
{
+#if DEBUG_CLIENT
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ "Transmission failed %u times, giving up.\n",
+ MAX_ATTEMPTS - th->attempts_left);
+#endif
GNUNET_break (0 == th->notify (th->notify_cls, 0, NULL));
GNUNET_free (th);
return 0;
}
/* auto-retry */
- GNUNET_CONNECTION_destroy (th->sock->sock);
+ GNUNET_CONNECTION_destroy (th->sock->sock, GNUNET_NO);
th->sock->sock = do_connect (th->sock->sched,
th->sock->service_name, th->sock->cfg);
GNUNET_assert (NULL != th->sock->sock);
- delay = GNUNET_TIME_relative_min (delay, GNUNET_TIME_UNIT_SECONDS);
- th->task = GNUNET_SCHEDULER_add_delayed (th->sock->sched,
- delay,
- &client_delayed_retry, th);
+ GNUNET_CONNECTION_ignore_shutdown (th->sock->sock,
+ th->sock->ignore_shutdown);
+ delay = GNUNET_TIME_relative_min (delay, th->sock->back_off);
+ th->sock->back_off
+ = GNUNET_TIME_relative_min (GNUNET_TIME_relative_multiply (th->sock->back_off, 2),
+ GNUNET_TIME_UNIT_SECONDS);
+#if DEBUG_CLIENT
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ "Transmission failed %u times, trying again in %llums.\n",
+ MAX_ATTEMPTS - th->attempts_left,
+ (unsigned long long) delay.value);
+#endif
+ th->reconnect_task = GNUNET_SCHEDULER_add_delayed (th->sock->sched,
+ delay,
+ &client_delayed_retry,
+ th);
th->sock->th = th;
return 0;
}
GNUNET_CLIENT_notify_transmit_ready_cancel (struct
GNUNET_CLIENT_TransmitHandle *th)
{
- if (th->task != GNUNET_SCHEDULER_NO_TASK)
+ if (th->reconnect_task != GNUNET_SCHEDULER_NO_TASK)
{
GNUNET_break (NULL == th->th);
- GNUNET_SCHEDULER_cancel (th->sock->sched, th->task);
+ GNUNET_SCHEDULER_cancel (th->sock->sched, th->reconnect_task);
+ th->reconnect_task = GNUNET_SCHEDULER_NO_TASK;
}
else
{
}
-/**
- * Context for processing
- * "GNUNET_CLIENT_transmit_and_get_response" requests.
- */
-struct TARCtx
-{
- /**
- * Client handle.
- */
- struct GNUNET_CLIENT_Connection *sock;
-
- /**
- * Message to transmit; do not free, allocated
- * right after this struct.
- */
- const struct GNUNET_MessageHeader *hdr;
-
- /**
- * Timeout to use.
- */
- struct GNUNET_TIME_Absolute timeout;
-
- /**
- * Function to call when done.
- */
- GNUNET_CLIENT_MessageHandler rn;
-
- /**
- * Closure for "rn".
- */
- void *rn_cls;
-};
-
-
/**
* Function called to notify a client about the socket
* begin ready to queue the message. "buf" will be
* NULL and "size" zero if the socket was closed for
* writing in the meantime.
*
- * @param cls closure of type "struct TARCtx*"
+ * @param cls closure of type "struct TransmitGetResponseContext*"
* @param size number of bytes available in buf
* @param buf where the callee should write the message
* @return number of bytes written to buf
static size_t
transmit_for_response (void *cls, size_t size, void *buf)
{
- struct TARCtx *tc = cls;
+ struct TransmitGetResponseContext *tc = cls;
uint16_t msize;
+ tc->sock->tag = NULL;
msize = ntohs (tc->hdr->size);
if (NULL == buf)
{
+#if DEBUG_CLIENT
+ GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
+ _("Could not submit request, not expecting to receive a response.\n"));
+#endif
tc->rn (tc->rn_cls, NULL);
GNUNET_free (tc);
return 0;
GNUNET_CLIENT_MessageHandler rn,
void *rn_cls)
{
- struct TARCtx *tc;
+ struct TransmitGetResponseContext *tc;
uint16_t msize;
if (NULL != sock->th)
return GNUNET_SYSERR;
+ GNUNET_assert (sock->tag == NULL);
msize = ntohs (hdr->size);
- tc = GNUNET_malloc (sizeof (struct TARCtx) + msize);
+ tc = GNUNET_malloc (sizeof (struct TransmitGetResponseContext) + msize);
tc->sock = sock;
tc->hdr = (const struct GNUNET_MessageHeader *) &tc[1];
memcpy (&tc[1], hdr, msize);
GNUNET_free (tc);
return GNUNET_SYSERR;
}
+ sock->tag = tc;
return GNUNET_OK;
}