Clarify semantics of freedom tcp sockets

iislucas commented 10 years ago

Lots of open questions for this interface that are not specified, but which are important if you try to use it:

Does calling close result in a onDisconnect event?
Does the promise form a close call fulfill when the connection is closed, or immidiately?
Does the promise from a listen call fulfill when the socket is listening?
Does an onConnection event guarantee that the socket is open?
Which error codes go with which methods/callbacks? e.g. is there anything for when secure fails?
Can you write to a socket that is not yet open? (will it queue, or give an error?)
Can onDisconnect event be fired more than once per socket?

willscott commented 10 years ago

For the initial question, you do get one of the defined errors when secure fails, no? I think we act as though the connection failed and reject with that error.

I don't understand the 4th bullet point.

It sounds like many of the other questions should be documented on a wiki page

iislucas commented 10 years ago

I've updated the issue on github; +1 for Wiki documentation & also documentation in the interface file. :)

willscott commented 9 years ago

@iislucas You've been spending a bunch of time thinking about the semantics of TCP Sockets. I wonder if I could convince you to write down the answers to these questions on a wiki doc now that you're familiar with the actual semantics :+1:

freedomjs / freedom

Clarify semantics of freedom tcp sockets #101