From 80e9ad0aacfd830070ba9efee4842e7b26470488 Mon Sep 17 00:00:00 2001 From: Gavin Norman Date: Tue, 8 Jan 2019 17:26:41 +0100 Subject: [PATCH] Add doc on request notifications that are considered fatal Part of #155. --- src/dhtproto/client/request/Exists.d | 6 ++++++ src/dhtproto/client/request/Get.d | 6 ++++++ src/dhtproto/client/request/GetAll.d | 5 +++++ src/dhtproto/client/request/GetChannels.d | 5 +++++ src/dhtproto/client/request/Mirror.d | 5 +++++ src/dhtproto/client/request/Put.d | 7 +++++++ src/dhtproto/client/request/Remove.d | 6 ++++++ src/dhtproto/client/request/RemoveChannel.d | 6 ++++++ src/dhtproto/client/request/Update.d | 6 ++++++ 9 files changed, 52 insertions(+) diff --git a/src/dhtproto/client/request/Exists.d b/src/dhtproto/client/request/Exists.d index 728a3c32..962421e4 100644 --- a/src/dhtproto/client/request/Exists.d +++ b/src/dhtproto/client/request/Exists.d @@ -46,6 +46,12 @@ public struct Args Union of possible notifications. + The following notifications are considered fatal (i.e. the request will + almost certainly get the same error if retried): + * node_error + * unsupported + * wrong_node + *******************************************************************************/ private union NotificationUnion diff --git a/src/dhtproto/client/request/Get.d b/src/dhtproto/client/request/Get.d index 583eecf0..196313dd 100644 --- a/src/dhtproto/client/request/Get.d +++ b/src/dhtproto/client/request/Get.d @@ -67,6 +67,12 @@ public struct Timeout Union of possible notifications. + The following notifications are considered fatal (i.e. the request will + almost certainly get the same error if retried): + * node_error + * unsupported + * wrong_node + *******************************************************************************/ private union NotificationUnion diff --git a/src/dhtproto/client/request/GetAll.d b/src/dhtproto/client/request/GetAll.d index d134f731..77d787d5 100644 --- a/src/dhtproto/client/request/GetAll.d +++ b/src/dhtproto/client/request/GetAll.d @@ -58,6 +58,11 @@ public struct Args Union of possible notifications. + The following notifications are considered fatal (i.e. the request will + almost certainly get the same error if retried): + * node_error + * unsupported + *******************************************************************************/ private union NotificationUnion diff --git a/src/dhtproto/client/request/GetChannels.d b/src/dhtproto/client/request/GetChannels.d index 2a5a46ab..0d92a2c0 100644 --- a/src/dhtproto/client/request/GetChannels.d +++ b/src/dhtproto/client/request/GetChannels.d @@ -35,6 +35,11 @@ public struct Args Union of possible notifications. + The following notifications are considered fatal (i.e. the request will + almost certainly get the same error if retried): + * node_error + * unsupported + *******************************************************************************/ private union NotificationUnion diff --git a/src/dhtproto/client/request/Mirror.d b/src/dhtproto/client/request/Mirror.d index 765506c3..16099672 100644 --- a/src/dhtproto/client/request/Mirror.d +++ b/src/dhtproto/client/request/Mirror.d @@ -85,6 +85,11 @@ public struct Args Union of possible notifications. + The following notifications are considered fatal (i.e. the request will + almost certainly get the same error if retried): + * node_error + * unsupported + *******************************************************************************/ private union NotificationUnion diff --git a/src/dhtproto/client/request/Put.d b/src/dhtproto/client/request/Put.d index 1370164d..cc7e0e5c 100644 --- a/src/dhtproto/client/request/Put.d +++ b/src/dhtproto/client/request/Put.d @@ -67,6 +67,13 @@ public struct Args Union of possible notifications. + The following notifications are considered fatal (i.e. the request will + almost certainly get the same error if retried): + * node_error + * unsupported + * wrong_node + * value_too_big + *******************************************************************************/ private union NotificationUnion diff --git a/src/dhtproto/client/request/Remove.d b/src/dhtproto/client/request/Remove.d index e46c412f..d8d7de77 100644 --- a/src/dhtproto/client/request/Remove.d +++ b/src/dhtproto/client/request/Remove.d @@ -53,6 +53,12 @@ public struct Args Union of possible notifications. + The following notifications are considered fatal (i.e. the request will + almost certainly get the same error if retried): + * node_error + * unsupported + * wrong_node + *******************************************************************************/ private union NotificationUnion diff --git a/src/dhtproto/client/request/RemoveChannel.d b/src/dhtproto/client/request/RemoveChannel.d index 27e48036..fe22191c 100644 --- a/src/dhtproto/client/request/RemoveChannel.d +++ b/src/dhtproto/client/request/RemoveChannel.d @@ -36,6 +36,12 @@ public struct Args Union of possible notifications. + The following notifications are considered fatal (i.e. the request will + almost certainly get the same error if retried): + * node_error + * unsupported + * not_permitted + *******************************************************************************/ private union NotificationUnion diff --git a/src/dhtproto/client/request/Update.d b/src/dhtproto/client/request/Update.d index 5429c32e..f444471a 100644 --- a/src/dhtproto/client/request/Update.d +++ b/src/dhtproto/client/request/Update.d @@ -64,6 +64,12 @@ public struct Args Union of possible notifications. + The following notifications are considered fatal (i.e. the request will + almost certainly get the same error if retried): + * node_error + * unsupported + * wrong_node + *******************************************************************************/ private union NotificationUnion