580448 - Document PCookieService.ipdl

Status: RESOLVED FIXED

(Core :: Networking: Cookies, defect)

Description

[Josh Matthews [:jdm]]

>+++ b/netwerk/cookie/PCookieService.ipdl
>+  sync GetCookieString(URI host,
>+                       URI originating,
>+                       bool fromHttp)
>+       returns (nsCString result);

What does "URI host" mean?  Is the caller expected to just send over some URI
with the right hostname, or do they need to trim everything except
scheme+host(+port?).  Or something else?

What's |originating|?

Comment 1

[Josh Matthews [:jdm]]

>+  SetCookieString(URI host,
>+                  URI originating,
>+                  nsCString cookieString,
>+                  nsCString serverTime,
>+                  bool fromHttp);

Similar here.  Also, document what serverTime's format is (or at least where it
should come from)?

Comment 2

[[e-mail]]

Attachment: patch

Comment 3

[Josh Matthews [:jdm]]

Comment on attachment 475909 [details] [diff] [review]
patch

>+   *        file:// URI's (i.e. with an empty host) are allowed, but any other

s/URI's/URIs

>+   *        file:// URI's (i.e. with an empty host) are allowed, but any other

same as above

I'm not sure how I feel about the completely duplicated documentation for the common parameters.  I'll defer to you, but I feel like it might be better to simply refer the viewer to the earlier docs if they're identical.

In fact, I'm not overjoyed about duplicating the docs from nsICookieService in the IPDL files.  If the parameters are the same, would it be enough to simply refer the reader to the originals, with a note about the identical nature?

Comment 4

[[e-mail]]

Attachment: v2

Comment 5

[Josh Matthews [:jdm]]

Comment on attachment 475932 [details] [diff] [review]
v2

r=me

Comment 6

[[e-mail]]

http://hg.mozilla.org/mozilla-central/rev/ae219ca8c0a1