1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
// Copyright 2023 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
// Configuration macros for the transfer module.
#pragma once
#include <chrono>
#include <cinttypes>
#include <limits>
#include "pw_chrono/system_clock.h"
// The default maximum number of times a transfer should retry sending a chunk
// when no response is received. This can later be configured per-transfer.
#ifndef PW_TRANSFER_DEFAULT_MAX_RETRIES
#define PW_TRANSFER_DEFAULT_MAX_RETRIES 3
#endif // PW_TRANSFER_DEFAULT_MAX_RETRIES
static_assert(PW_TRANSFER_DEFAULT_MAX_RETRIES > 0 &&
PW_TRANSFER_DEFAULT_MAX_RETRIES <=
std::numeric_limits<uint8_t>::max());
// The default maximum number of times a transfer should retry sending a chunk
// over the course of its entire lifetime.
// This number should be high, particularly if long-running transfers are
// expected. Its purpose is to prevent transfers from getting stuck in an
// infinite loop.
#ifndef PW_TRANSFER_DEFAULT_MAX_LIFETIME_RETRIES
#define PW_TRANSFER_DEFAULT_MAX_LIFETIME_RETRIES \
(static_cast<uint32_t>(PW_TRANSFER_DEFAULT_MAX_RETRIES) * 1000u)
#endif // PW_TRANSFER_DEFAULT_MAX_LIFETIME_RETRIES
static_assert(PW_TRANSFER_DEFAULT_MAX_LIFETIME_RETRIES >
PW_TRANSFER_DEFAULT_MAX_RETRIES &&
PW_TRANSFER_DEFAULT_MAX_LIFETIME_RETRIES <=
std::numeric_limits<uint32_t>::max());
// The default amount of time, in milliseconds, to wait for a chunk to arrive
// before retrying. This can later be configured per-transfer.
#ifndef PW_TRANSFER_DEFAULT_TIMEOUT_MS
#define PW_TRANSFER_DEFAULT_TIMEOUT_MS 2000
#endif // PW_TRANSFER_DEFAULT_TIMEOUT_MS
static_assert(PW_TRANSFER_DEFAULT_TIMEOUT_MS > 0);
// The default amount of time, in milliseconds, to wait for an initial server
// response to a transfer before retrying. This can later be configured
// per-transfer.
//
// This is set separately to PW_TRANSFER_DEFAULT_TIMEOUT_MS as transfers may
// require additional time for resource initialization (e.g. erasing a flash
// region before writing to it).
#ifndef PW_TRANSFER_DEFAULT_INITIAL_TIMEOUT_MS
#define PW_TRANSFER_DEFAULT_INITIAL_TIMEOUT_MS PW_TRANSFER_DEFAULT_TIMEOUT_MS
#endif // PW_TRANSFER_DEFAULT_INITIAL_TIMEOUT_MS
static_assert(PW_TRANSFER_DEFAULT_INITIAL_TIMEOUT_MS > 0);
// The fractional position within a window at which a receive transfer should
// extend its window size to minimize the amount of time the transmitter
// spends blocked.
//
// For example, a divisor of 2 will extend the window when half of the
// requested data has been received, a divisor of three will extend at a third
// of the window, and so on.
#ifndef PW_TRANSFER_DEFAULT_EXTEND_WINDOW_DIVISOR
#define PW_TRANSFER_DEFAULT_EXTEND_WINDOW_DIVISOR 2
#endif // PW_TRANSFER_DEFAULT_EXTEND_WINDOW_DIVISOR
static_assert(PW_TRANSFER_DEFAULT_EXTEND_WINDOW_DIVISOR > 1);
namespace pw::transfer::cfg {
inline constexpr uint8_t kDefaultMaxRetries = PW_TRANSFER_DEFAULT_MAX_RETRIES;
inline constexpr uint16_t kDefaultMaxLifetimeRetries =
PW_TRANSFER_DEFAULT_MAX_LIFETIME_RETRIES;
inline constexpr chrono::SystemClock::duration kDefaultChunkTimeout =
std::chrono::milliseconds(PW_TRANSFER_DEFAULT_TIMEOUT_MS);
inline constexpr chrono::SystemClock::duration kDefaultInitialChunkTimeout =
std::chrono::milliseconds(PW_TRANSFER_DEFAULT_INITIAL_TIMEOUT_MS);
inline constexpr uint32_t kDefaultExtendWindowDivisor =
PW_TRANSFER_DEFAULT_EXTEND_WINDOW_DIVISOR;
} // namespace pw::transfer::cfg
|
