x.websocket: vdoc (#7091)

vlib/x/websocket/events.v

@@ -1,35 +1,35 @@
 module websocket
 
-// Represents a callback on a new message
+// MessageEventHandler represents a callback on a new message
 struct MessageEventHandler {
-	handler  SocketMessageFn // Callback function
-	handler2 SocketMessageFn2 // Callback function with reference
-	is_ref   bool // Has a reference object
-	ref      voidptr // The referenced object
+	handler  SocketMessageFn // callback function
+	handler2 SocketMessageFn2 // callback function with reference
+	is_ref   bool // true if has a reference object
+	ref      voidptr // referenced object
 }
 
-// Represents a callback on error
+// ErrorEventHandler represents a callback on error
 struct ErrorEventHandler {
-	handler  SocketErrorFn // Callback function
-	handler2 SocketErrorFn2 // Callback function with reference
-	is_ref   bool // Has a reference object
-	ref      voidptr // The referenced object
+	handler  SocketErrorFn // callback function
+	handler2 SocketErrorFn2 // callback function with reference
+	is_ref   bool // true if has a reference object
+	ref      voidptr // referenced object
 }
 
-// Represents a callback when connection is opened
+// OpenEventHandler represents a callback when connection is opened
 struct OpenEventHandler {
-	handler  SocketOpenFn // Callback function
-	handler2 SocketOpenFn2 // Callback function with reference
-	is_ref   bool // Has a reference object
-	ref      voidptr // The referenced object
+	handler  SocketOpenFn // callback function
+	handler2 SocketOpenFn2 // callback function with reference
+	is_ref   bool // true if has a reference object
+	ref      voidptr // referenced object
 }
 
-// Represents a callback on a closing event
+// CloseEventHandler represents a callback on a closing event
 struct CloseEventHandler {
-	handler  SocketCloseFn
-	handler2 SocketCloseFn2
-	is_ref   bool
-	ref      voidptr
+	handler  SocketCloseFn // callback function
+	handler2 SocketCloseFn2 // callback function with reference
+	is_ref   bool // true if has a reference object
+	ref      voidptr // referenced object
 }
 
 pub type AcceptClientFn = fn (mut c ServerClient) ?bool
@@ -50,7 +50,7 @@ pub type SocketCloseFn = fn (mut c Client, code int, reason string) ?
 
 pub type SocketCloseFn2 = fn (mut c Client, code int, reason string, v voidptr) ?
 
-// on_connect register callback when client connects to the server
+// on_connect registers a callback when client connects to the server
 pub fn (mut s Server) on_connect(fun AcceptClientFn) ? {
 	if s.accept_client_callbacks.len > 0 {
 		return error('only one callback can be registered for accept client')
@@ -58,14 +58,14 @@ pub fn (mut s Server) on_connect(fun AcceptClientFn) ? {
 	s.accept_client_callbacks << fun
 }
 
-// on_message, register a callback on new messages
+// on_message registers a callback on new messages
 pub fn (mut s Server) on_message(fun SocketMessageFn) {
 	s.message_callbacks << MessageEventHandler{
 		handler: fun
 	}
 }
 
-// on_message_ref, register a callback on new messages and provide a reference
+// on_message_ref registers a callback on new messages and provides a reference object
 pub fn (mut s Server) on_message_ref(fun SocketMessageFn2, ref voidptr) {
 	s.message_callbacks << MessageEventHandler{
 		handler2: fun
@@ -74,14 +74,14 @@ pub fn (mut s Server) on_message_ref(fun SocketMessageFn2, ref voidptr) {
 	}
 }
 
-// on_close, register a callback on closed socket
+// on_close registers a callback on closed socket
 pub fn (mut s Server) on_close(fun SocketCloseFn) {
 	s.close_callbacks << CloseEventHandler{
 		handler: fun
 	}
 }
 
-// on_close_ref, register a callback on closed socket and provide a reference
+// on_close_ref registers a callback on closed socket and provides a reference object
 pub fn (mut s Server) on_close_ref(fun SocketCloseFn2, ref voidptr) {
 	s.close_callbacks << CloseEventHandler{
 		handler2: fun
@@ -90,14 +90,14 @@ pub fn (mut s Server) on_close_ref(fun SocketCloseFn2, ref voidptr) {
 	}
 }
 
-// on_message, register a callback on new messages
+// on_message registers a callback on new messages
 pub fn (mut ws Client) on_message(fun SocketMessageFn) {
 	ws.message_callbacks << MessageEventHandler{
 		handler: fun
 	}
 }
 
-// on_message_ref, register a callback on new messages and provide a reference
+// on_message_ref registers a callback on new messages and provides a reference object
 pub fn (mut ws Client) on_message_ref(fun SocketMessageFn2, ref voidptr) {
 	ws.message_callbacks << MessageEventHandler{
 		handler2: fun
@@ -106,14 +106,14 @@ pub fn (mut ws Client) on_message_ref(fun SocketMessageFn2, ref voidptr) {
 	}
 }
 
-// on_error, register a callback on errors
+// on_error registers a callback on errors
 pub fn (mut ws Client) on_error(fun SocketErrorFn) {
 	ws.error_callbacks << ErrorEventHandler{
 		handler: fun
 	}
 }
 
-// on_error_ref, register a callback on errors and provida a reference
+// on_error_ref registers a callback on errors and provides a reference object
 pub fn (mut ws Client) on_error_ref(fun SocketErrorFn2, ref voidptr) {
 	ws.error_callbacks << ErrorEventHandler{
 		handler2: fun
@@ -122,14 +122,15 @@ pub fn (mut ws Client) on_error_ref(fun SocketErrorFn2, ref voidptr) {
 	}
 }
 
-// on_open, register a callback on successful open
+// on_open registers a callback on successful opening the websocket
 pub fn (mut ws Client) on_open(fun SocketOpenFn) {
 	ws.open_callbacks << OpenEventHandler{
 		handler: fun
 	}
 }
 
-// on_open_ref, register a callback on successful open and provide a reference
+// on_open_ref registers a callback on successful opening the websocket
+// and provides a reference object
 pub fn (mut ws Client) on_open_ref(fun SocketOpenFn2, ref voidptr) {
 	ws.open_callbacks << OpenEventHandler{
 		handler2: fun
@@ -138,14 +139,14 @@ pub fn (mut ws Client) on_open_ref(fun SocketOpenFn2, ref voidptr) {
 	}
 }
 
-// on_close, register a callback on closed socket
+// on_close registers a callback on closed socket
 pub fn (mut ws Client) on_close(fun SocketCloseFn) {
 	ws.close_callbacks << CloseEventHandler{
 		handler: fun
 	}
 }
 
-// on_close_ref, register a callback on closed socket and provide a reference
+// on_close_ref registers a callback on closed socket and provides a reference object
 pub fn (mut ws Client) on_close_ref(fun SocketCloseFn2, ref voidptr) {
 	ws.close_callbacks << CloseEventHandler{
 		handler2: fun
@@ -154,7 +155,7 @@ pub fn (mut ws Client) on_close_ref(fun SocketCloseFn2, ref voidptr) {
 	}
 }
 
-// send_connect_event, invokes the on_connect callback
+// send_connect_event invokes the on_connect callback
 fn (mut s Server) send_connect_event(mut c ServerClient) ?bool {
 	if s.accept_client_callbacks.len == 0 {
 		// If no callback all client will be accepted