[Bug 28705] More documentation about credentials and components in stream

[bugzilla-daemon at freedesktop.org]

https://bugs.freedesktop.org/show_bug.cgi?id=28705

--- Comment #4 from David Laban <david.laban at collabora.co.uk> 2011-03-03 10:16:22 PST ---
(sorry if this comment happens twice: I thought I submitted it last night, but
it wasn't there when I refreshed)

> About Candidate_Info:
> - Type is a uint, but we have no idea what the values mean
Made a new enum Call_Stream_Candidate_Type, with docs. Quite tempted to rename
this to "topology", because Type is a bit generic. Thoughts?

I had to do a bit of s/\t/        /. Remember to set up your editor correctly
next time you do spec work.
> - BaseIP should be a string, not uint
Changed this, but I don't know what this is used for, so I was unable to add a
useful docstring.
> - BasePort is missing
Added this, but again without a very useful docstring.

> - What is the scale of the priority? (it should be a number between 0 and
> 65535)
Done.

> - Add multicast type and a TTL field for it
There is already a multicast type for the Stream. I have added one for the
candidate too, and put it as a separate patch.

> - Protocol is also a uint, but we have no idea what it means
Referenced to base proto from StreamedMedia.

> - RawUDPFallback should go away, the lowest priority candidate is normally the
> fallback (its the relay).
Done. If I remember correctly, the rationale for this is that you can know
whether you're using ICE or rawudp from the type of the endpoint when it pops
up, and the CM can pick the lowest priority candidate as its rawudp candidate.
I also expanded the documentation of Priority (which addresses #34038) while I
was at it.

> Maybe PleaseRestartICE() should have a matching property for recoverability?
Haven't addressed this. Could this be done by exposing the CM's view of the
state machine for the stream, or would you say that it is orthogonal? Also, you
say that LocalCredentials is mostly useful for debugging. Could we just set it
to "", "" but not clear LocalCandidates when we emit PleaseRestartIce?

I also noticed that the keys for CandidateInfo are Capitalised, and the keys
for RelayInfo are lowercase. Should I leave this as-is or should we standardise
on one method of capitalisation?

pushed to alsuren/stream-etc
(http://git.collabora.co.uk/?p=user/alsuren/telepathy-spec.git;a=shortlog;h=refs/heads/stream-etc)

-- 
Configure bugmail: https://bugs.freedesktop.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA contact for the bug.
You are the assignee for the bug.