#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
/**
GNUNET_SCHEDULER_TaskIdentifier reconnect_task;
/**
- * Timeout.
+ * Timeout for the operation overall.
*/
struct GNUNET_TIME_Absolute timeout;
void *rn_cls;
};
+/**
+ * Context for handling the shutdown of a service.
+ */
+struct ShutdownContext
+{
+ /**
+ * Scheduler to be used to call continuation
+ */
+ struct GNUNET_SCHEDULER_Handle *sched;
+ /**
+ * Connection to the service that is being shutdown.
+ */
+ struct GNUNET_CLIENT_Connection *sock;
+
+ /**
+ * Time allowed for shutdown to happen.
+ */
+ struct GNUNET_TIME_Absolute timeout;
+
+ /**
+ * Task set up to cancel the shutdown request on timeout.
+ */
+ GNUNET_SCHEDULER_TaskIdentifier cancel_task;
+
+ /**
+ * Task to call once shutdown complete
+ */
+ GNUNET_CLIENT_ShutdownTask cont;
+
+ /**
+ * Closure for shutdown continuation
+ */
+ void *cont_cls;
+
+ /**
+ * We received a confirmation that the service will shut down.
+ */
+ int confirmed;
+
+};
/**
* Struct to refer to a GNUnet TCP connection.
*/
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.
*/
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.
*/
*/
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;
}
+/**
+ * Configure this connection to ignore shutdown signals.
+ *
+ * @param h client handle
+ * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
+ */
+void
+GNUNET_CLIENT_ignore_shutdown (struct GNUNET_CLIENT_Connection *h,
+ int do_ignore)
+{
+ h->ignore_shutdown = do_ignore;
+ if (h->sock != NULL)
+ GNUNET_CONNECTION_ignore_shutdown (h->sock,
+ do_ignore);
+}
+
+
/**
* Destroy connection with the service. This will automatically
* cancel any pending "receive" request (however, the handler will
* *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 (unless, of course, there is an error with the server
- * in which case the message may still be lost).
+ * 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);
if (sock->in_receive == GNUNET_YES)
GNUNET_CONNECTION_receive_cancel (sock->sock);
sock->in_receive = GNUNET_NO;
}
- GNUNET_CONNECTION_destroy (sock->sock);
+ GNUNET_CONNECTION_destroy (sock->sock, finish_pending_write);
sock->sock = NULL;
if (sock->tag != 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);
+ 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);
/* signal timeout! */
if (NULL != (receive_handler = conn->receiver_handler))
{
- receive_handler_cls = conn->receiver_handler_cls;
+ receive_handler_cls = conn->receiver_handler_cls;
conn->receiver_handler = NULL;
receive_handler (receive_handler_cls, NULL);
}
if (GNUNET_YES == sock->msg_complete)
{
sock->receive_task = GNUNET_SCHEDULER_add_after (sock->sched,
- GNUNET_SCHEDULER_NO_TASK,
- &receive_task, sock);
+ GNUNET_SCHEDULER_NO_TASK,
+ &receive_task, sock);
}
else
{
sock->in_receive = GNUNET_YES;
GNUNET_CONNECTION_receive (sock->sock,
- GNUNET_SERVER_MAX_MESSAGE_SIZE,
- timeout, &receive_helper, sock);
+ GNUNET_SERVER_MAX_MESSAGE_SIZE,
+ timeout, &receive_helper, sock);
+ }
+}
+
+
+/**
+ * Handler receiving response to service shutdown requests.
+ * First call with NULL: service misbehaving, or something.
+ * First call with GNUNET_MESSAGE_TYPE_SHUTDOWN_ACK:
+ * - service will shutdown
+ * First call with GNUNET_MESSAGE_TYPE_SHUTDOWN_REFUSE:
+ * - service will not be stopped!
+ *
+ * Second call with NULL:
+ * - service has now really shut down.
+ *
+ * @param cls closure
+ * @param msg NULL, indicating socket closure.
+ */
+static void
+service_shutdown_handler (void *cls, const struct GNUNET_MessageHeader *msg)
+{
+ struct ShutdownContext *shutdown_ctx = cls;
+
+ if ((msg == NULL) && (shutdown_ctx->confirmed != GNUNET_YES))
+ {
+ /* Means the other side closed the connection and never confirmed a shutdown */
+ GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
+ "Service handle shutdown before ACK!\n");
+ if (shutdown_ctx->cont != NULL)
+ shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);
+ GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
+ GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
+ GNUNET_free(shutdown_ctx);
+ }
+ else if ((msg == NULL) && (shutdown_ctx->confirmed == GNUNET_YES))
+ {
+ GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
+ "Service shutdown complete.\n");
+ if (shutdown_ctx->cont != NULL)
+ shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_NO);
+
+ GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
+ GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
+ GNUNET_free(shutdown_ctx);
+ }
+ else
+ {
+ GNUNET_assert(ntohs(msg->size) == sizeof(struct GNUNET_MessageHeader));
+
+ switch (ntohs(msg->type))
+ {
+ case GNUNET_MESSAGE_TYPE_SHUTDOWN_ACK:
+ GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
+ "Received confirmation for service shutdown.\n");
+ shutdown_ctx->confirmed = GNUNET_YES;
+ GNUNET_CLIENT_receive (shutdown_ctx->sock,
+ &service_shutdown_handler,
+ shutdown_ctx,
+ GNUNET_TIME_UNIT_FOREVER_REL);
+ break;
+ case GNUNET_MESSAGE_TYPE_SHUTDOWN_REFUSE:
+ default: /* Fall through */
+ GNUNET_log(GNUNET_ERROR_TYPE_WARNING,
+ "Service shutdown refused!\n");
+ if (shutdown_ctx->cont != NULL)
+ shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_YES);
+
+ GNUNET_SCHEDULER_cancel(shutdown_ctx->sched, shutdown_ctx->cancel_task);
+ GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
+ GNUNET_free(shutdown_ctx);
+ break;
+ }
}
}
+/**
+ * Shutting down took too long, cancel receive and return error.
+ *
+ * @param cls closure
+ * @param tc context information (why was this task triggered now)
+ */
+void service_shutdown_cancel (void *cls,
+ const struct GNUNET_SCHEDULER_TaskContext * tc)
+{
+ struct ShutdownContext *shutdown_ctx = cls;
+ GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "service_shutdown_cancel called!\n");
+ shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);
+ GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
+ GNUNET_free(shutdown_ctx);
+}
+
/**
* If possible, write a shutdown message to the target
write_shutdown (void *cls, size_t size, void *buf)
{
struct GNUNET_MessageHeader *msg;
- struct GNUNET_CLIENT_Connection *sock = cls;
+ struct ShutdownContext *shutdown_ctx = cls;
- GNUNET_CLIENT_disconnect (sock);
if (size < sizeof (struct GNUNET_MessageHeader))
{
- GNUNET_log (GNUNET_ERROR_TYPE_INFO,
+ GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
_("Failed to transmit shutdown request to client.\n"));
+ shutdown_ctx->cont(shutdown_ctx->cont_cls, GNUNET_SYSERR);
+ GNUNET_CLIENT_disconnect (shutdown_ctx->sock, GNUNET_NO);
+ GNUNET_free(shutdown_ctx);
return 0; /* client disconnected */
}
+
+ GNUNET_CLIENT_receive (shutdown_ctx->sock,
+ &service_shutdown_handler, shutdown_ctx,
+ GNUNET_TIME_UNIT_FOREVER_REL);
+ shutdown_ctx->cancel_task = GNUNET_SCHEDULER_add_delayed (shutdown_ctx->sched,
+ GNUNET_TIME_absolute_get_remaining(shutdown_ctx->timeout),
+ &service_shutdown_cancel,
+ shutdown_ctx);
msg = (struct GNUNET_MessageHeader *) buf;
msg->type = htons (GNUNET_MESSAGE_TYPE_SHUTDOWN);
msg->size = htons (sizeof (struct GNUNET_MessageHeader));
/**
* Request that the service should shutdown.
- * Afterwards, the connection should be disconnected.
+ * Afterwards, the connection will automatically be
+ * disconnected. Hence the "sock" should not
+ * be used by the caller after this call
+ * (calling this function frees "sock" after a while).
*
+ * @param sched the scheduler to use for calling shutdown continuation
* @param sock the socket connected to the service
+ * @param timeout how long to wait before giving up on transmission
+ * @param cont continuation to call once the service is really down
+ * @param cont_cls closure for continuation
+ *
*/
void
-GNUNET_CLIENT_service_shutdown (struct GNUNET_CLIENT_Connection *sock)
+GNUNET_CLIENT_service_shutdown (struct GNUNET_SCHEDULER_Handle *sched,
+ struct GNUNET_CLIENT_Connection *sock,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_CLIENT_ShutdownTask cont,
+ void *cont_cls)
{
+ struct ShutdownContext *shutdown_ctx;
+ shutdown_ctx = GNUNET_malloc(sizeof(struct ShutdownContext));
+ shutdown_ctx->sched = sched;
+ shutdown_ctx->cont = cont;
+ shutdown_ctx->cont_cls = cont_cls;
+ shutdown_ctx->sock = sock;
+ shutdown_ctx->timeout = GNUNET_TIME_relative_to_absolute(timeout);
GNUNET_CONNECTION_notify_transmit_ready (sock->sock,
sizeof (struct
GNUNET_MessageHeader),
- GNUNET_TIME_UNIT_FOREVER_REL,
- &write_shutdown, sock);
+ timeout,
+ &write_shutdown, shutdown_ctx);
}
{
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 `%s' request.\n",
- "TEST");
+ "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);
}
{
#if DEBUG_CLIENT
GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
- "Transmission failed due to shutdown.\n");
+ "Transmission failed due to shutdown.\n");
#endif
+ th->sock->th = NULL;
th->notify (th->notify_cls, 0, NULL);
GNUNET_free (th);
return;
/**
- * 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
th->sock->th = NULL;
if (buf == NULL)
{
- // FIXME: need a way to check if the
- // reason is SHUTDOWN (not timeout) and
- // if so NOT retry!
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);
+ 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);
+ 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);
+ "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);
+ delay,
+ &client_delayed_retry,
+ th);
th->sock->th = th;
return 0;
}
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;
projects / oweals / gnunet.git / blobdiff