Document SDLPrioritizedObjectCollection priority lower is 'higher'

[joeljfischer]

It should retrieve high priority objects first, but instead retrieves low priority objects first.

Because this is used with service numbers, lower numbers indicate higher priority. Since this semantically odd, it should be documented within the class.

[joeljfischer]

@hugh22 @Heath-FoMoCo Are lower numbers higher priority? Because that would mean this is functional then, just semantically weird.

[hugh22]

Nope, that looks like an error. The current spec (which I suspect will need changing) is to use the number of the service type as the priority with higher values going first.

[joeljfischer]

Okay, thanks, just wanted to make sure

[joeljfischer]

I plan to hold off fixing this until unit tests are merged so that I can test the fix properly.

[justinjdickow]

The current specification says, in section 4.

Lower service numbers have higher priority and are sent ahead of higher service numbers.

I don't have an exact reference because I rewrote the protocol spec for GitHub but my wording is

Lower values for service type have higher delivery priority.

[joeljfischer]

@justinjdickow @hugh22 So...it's functional then? Just semantically odd? I can just change the test for high priority to be a lower number, and it should pass.

[justinjdickow]

@joeljfischer Assuming the service number is always used as the priority, it would seem it is functionally correct

[joeljfischer]

Alright, I'll alter the test then. This should be documented within the SDLPrioritizedObjectCollection class.

[joeljfischer]

Alright, I'll alter the test then. This should be documented within the SDLPrioritizedObjectCollection class.

[hugh22]

Yeah, that's right. It got turned around so that an RPC can pre-empt video streams.