search

charJe / portal

Portable Websocket Server for Common Lisp. THIS PROJECT HAS MOVED
https://git.sr.ht/~charje/cl-portal
Other
28 stars 4 forks source link

Add documentation for websocket class #4

Open jgarte opened 2 years ago

jgarte commented 2 years ago

Let's add some nice conceptual documentation/background info for how the websocket class fits in with the rest of the library.

https://github.com/charJe/portal/blob/master/portal.lisp#L220

charJe commented 2 years ago

We can start with "Represents the connection to a Websocket client."

jgarte commented 2 years ago

I started reading RFC 6455 today but I'll have to find the time to finish and assimilate it. Might be nice to associate parts of RFC 6455 with the code somehow. Maybe comments referring to sections where the RFC 6455 association and its CL implementation were a very clear one to one.

charJe commented 2 years ago

That's a great idea. Those comments would mostly exist in the send and read-frame methods.