Make GetRTCPPackets and GetRTPHeader nil-safe#431
Merged
Conversation
Allow both `GetRTCPPackets()` and `GetRTPHeader()` to be called on nil attributes without panicking. Instead, they will unmarshal but not cache the results when called on a nil receiver.
JoTurk
approved these changes
Jul 24, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #431 +/- ##
=======================================
Coverage 80.14% 80.15%
=======================================
Files 88 88
Lines 4623 4625 +2
=======================================
+ Hits 3705 3707 +2
Misses 735 735
Partials 183 183
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
kcaffrey
added a commit
to kcaffrey/webrtc
that referenced
this pull request
Jul 24, 2026
Currently an interceptor.Attributes map is allocated for each RTP write. However, interceptors only strictly need to allocate an attributes map when wanting to set a value. None of the default interceptors currently allocate a new map when passed nil on the write path. The gcc.SendSideBWE interceptor, when TWCC is negotiated, does allocate attributes for every outbound packet. Thus, by sending nil instead of allocating a new map, we can save one allocation per `WriteRTP()` All interceptors in pion/interceptor are already safe with nil attributes on the write path, and pion/interceptor#431 made `GetRTPHeader()` and `GetRTCPPackets()` safe to call on nil attributes. Users with custom interceptors should ensure that attributes is always checked for nil before calling `Set()`. The benchmark added in this package shows a reduction of allocations for a write+read round trip from 8 allocs/op to 7 allocs/op.
kcaffrey
added a commit
to pion/webrtc
that referenced
this pull request
Jul 24, 2026
Currently an interceptor.Attributes map is allocated for each RTP write. However, interceptors only strictly need to allocate an attributes map when wanting to set a value. None of the default interceptors currently allocate a new map when passed nil on the write path. The gcc.SendSideBWE interceptor, when TWCC is negotiated, does allocate attributes for every outbound packet. Thus, by sending nil instead of allocating a new map, we can save one allocation per `WriteRTP()` All interceptors in pion/interceptor are already safe with nil attributes on the write path, and pion/interceptor#431 made `GetRTPHeader()` and `GetRTCPPackets()` safe to call on nil attributes. Users with custom interceptors should ensure that attributes is always checked for nil before calling `Set()`. The benchmark added in this package shows a reduction of allocations for a write+read round trip from 8 allocs/op to 7 allocs/op.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Allow both
GetRTCPPackets()andGetRTPHeader()to be called on nil attributes without panicking. Instead, they will unmarshal but not cache the results when called on a nil receiver.See the discussion in pion/webrtc#3483 for more background on this change.