Add WithContext versions of functions that use contexts. #555
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hugelgupf
reviewed
Jan 8, 2025
| // won't be a valid DHCPv4 message so you will need to adjust its fields. | ||
| // See also NewDiscovery, NewRequest, NewAcknowledge, NewInform and NewRelease. | ||
| // won't be a valid DHCPv4 message so you will need to adjust its fields. See | ||
| // also NewDiscovery, NewRequest, NewAcknowledge, NewInform and NewRelease. | ||
| func New(modifiers ...Modifier) (*DHCPv4, error) { |
There was a problem hiding this comment.
can you make New be a wrapper of NewWithContext as well? just so changes to one aren't forgotten in the other.
There was a problem hiding this comment.
Done with e0b42be.
These new functions are equivalent, but allow callers to pass a context down from main (or equivalent). This is necessary to comply with certain style guides, for example, https://google.github.io/styleguide/go/decisions#contexts. We considered replacing dhcpv4.GenerateTransactionID with rand.Read(xid[:]) based on the godoc saying that Read call "never returns an error", but this package is used in embedded situations where it can fail. Signed-off-by: Mark Suter <[email protected]>
…omment. Signed-off-by: Mark Suter <[email protected]>
hugelgupf
previously approved these changes
Jan 9, 2025
Signed-off-by: Mark Suter <[email protected]>
hugelgupf
approved these changes
Jan 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These new functions are equivalent, but allow callers to pass a context down from main (or equivalent). This is necessary to comply with certain style guides, for example, https://google.github.io/styleguide/go/decisions#contexts.
We considered replacing dhcpv4.GenerateTransactionID with rand.Read(xid[:]) based on the godoc saying that Read call "never returns an error", but this package is used in embedded situations where it can fail.