Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement transport send and receive timeouts in coreHTTP #83

Merged
merged 19 commits into from
Dec 11, 2020
Merged

Implement transport send and receive timeouts in coreHTTP #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
487aa9f
Add definitions of timeout function and macros.
sarenameas Dec 10, 2020
817ffd4
Implement receive retry timeout.
sarenameas Dec 10, 2020
f862cde
Implement sent retry timeout.
sarenameas Dec 10, 2020
accf944
Handle the case where the user did not set the getTime function.
sarenameas Dec 10, 2020
541b04a
Fix documentation, complexity, transport interface, and spelling.
sarenameas Dec 10, 2020
3d15e45
Fix errors to make all current tests pass.
sarenameas Dec 10, 2020
f314b60
Add test for coverage of a receive timeout greater than zero.
sarenameas Dec 11, 2020
8803e82
Add tests for coverage ofa sent timeout greater than zero.
sarenameas Dec 11, 2020
4991733
Update the default timeouts to match coreMQTT.
sarenameas Dec 11, 2020
a87604c
Add configs to the doxygen.
sarenameas Dec 11, 2020
e25cc9b
Undo transport interface changes/
sarenameas Dec 11, 2020
3c8a104
Merge branch 'main' into timeout3
sarenameas Dec 11, 2020
241ab54
Fix some spellings.
sarenameas Dec 11, 2020
a4025a0
Add some more docs about porting the new configs and hwo the config i…
sarenameas Dec 11, 2020
e654445
Update CBMC proofs for the change.
sarenameas Dec 11, 2020
e2e2348
Uncrustify.
sarenameas Dec 11, 2020
bb34fe2
Address PR comments.
sarenameas Dec 11, 2020
a2908df
Fix build errors left in logging.
sarenameas Dec 11, 2020
871ab8f
Update test/unit-test/core_http_send_utest.c
sarenameas Dec 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/doxygen/pages.dox
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,8 @@ then the @ref HTTP_DO_NOT_USE_CUSTOM_CONFIG macro must be defined.
The following macros can be configured for this library:
- @ref HTTP_MAX_RESPONSE_HEADERS_SIZE_BYTES
- @ref HTTP_USER_AGENT_VALUE
- @ref HTTP_SEND_RETRY_TIMEOUT_MS
- @ref HTTP_RECV_RETRY_TIMEOUT_MS

In addition, the following logging macros are used throughout this library:
- @ref LogError
Expand Down Expand Up @@ -232,6 +234,22 @@ struct NetworkContext {
// Fields necessary for the transport implementations, e.g. a TCP socket descriptor.
};
@endcode

@section http_porting_time Time Function
@brief The HTTP library optionally relies on a function to generate millisecond
timestamps, for the purpose of calculating the elapsed time when no data has
been sent or received.

@see @ref HTTPClient_GetCurrentTimeFunc_t

Applications can supply their platform-specific function capable of generating
32-bit timestamps of millisecond resolution. These timestamps need not correspond
with any real world clock; the only requirement is that the difference between two
timestamps must be an accurate representation of the duration between them, in
milliseconds.

This function is used in conjunction with macros @ref HTTP_SEND_RETRY_TIMEOUT_MS
and @ref HTTP_RECV_RETRY_TIMEOUT_MS.
*/

/**
Expand Down Expand Up @@ -259,6 +277,12 @@ defined.
@section HTTP_USER_AGENT_VALUE
@copydoc HTTP_USER_AGENT_VALUE

@section HTTP_SEND_RETRY_TIMEOUT_MS
@copydoc HTTP_SEND_RETRY_TIMEOUT_MS

@section HTTP_RECV_RETRY_TIMEOUT_MS
@copydoc HTTP_RECV_RETRY_TIMEOUT_MS

@section http_logerror LogError
@copydoc LogError

Expand Down
5 changes: 5 additions & 0 deletions lexicon.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ findheaderonheadercompletecallback
findheadervalueparsercallback
firstpartbytes
getfinalresponsestatus
gettime
gettimestampms
github
headercount
headerslen
Expand Down Expand Up @@ -199,6 +201,7 @@ receivehttpdata
recv
recvcurrentcall
recvstopcall
recvtimeoutcall
reponse
reqbodybuflen
reqbodylen
Expand All @@ -213,6 +216,8 @@ rfc
sdk
senderrorcall
sendflags
sendhttpbody
sendhttpheaders
sendpartialcall
sizeof
snprintf
Expand Down
Loading