Verawebsockets - Revision history

Mcvflorin at 09:54, 9 March 2018

2018-03-09T09:54:24Z

Mcvflorin: /* loop */

2018-03-09T08:18:27Z

‎loop

Mcvflorin: /* loop */

2018-03-09T08:15:34Z

‎loop

Mcvflorin: /* create */

2018-03-09T08:11:19Z

‎create

Mcvflorin: /* set_log_level */

2018-03-09T07:21:34Z

‎set_log_level

Mcvflorin: /* set_log_level */

2018-03-09T07:20:06Z

‎set_log_level

Mcvflorin: /* connect */

2018-03-08T15:56:52Z

‎connect

Mcvflorin: /* create */

2018-03-08T15:52:35Z

‎create

Mcvflorin at 12:13, 8 March 2018

2018-03-08T12:13:35Z

Mcvflorin at 12:07, 8 March 2018

2018-03-08T12:07:40Z

@@ Line 166: / Line 166: @@
 | style="border: 1px solid #000; padding-left: 10px" | User
 |}
 <br>
 == Further documentation ==

@@ Line 29: / Line 29: @@
 === loop ===
 This function must be called if the [[#create|''create'']] function was called with the ''standalone'' parameter set to ''true''.
-This function blocks the main thread, waiting for the service thread to finish execution.
+It blocks the main thread, waiting for the service thread to finish execution.
 Parameters:

@@ Line 28: / Line 28: @@
 === loop ===
 Parameters:
 * none

@@ Line 14: / Line 14: @@
 * '''event_handlers''' (table): A table where the index is the [[#Event_IDs|event ID]], and the value is the callback function name.
 * '''ssl_settings''' (table): A table where the index is the SSL setting name, and the value is the SSL setting value.
-* '''standalone''' (boolean): Set this to '''true''' if using the library from a standalone Lua script, or to '''false''' if using the library from LuaUPnP. If not set, the default value is '''false'''.
+* '''standalone''' (boolean): Set this to '''true''' if using the library from a standalone Lua script, or to '''false''' if using the library from LuaUPnP. If not set, the default value is '''false'''. If ''standalone'' is ''true'', you must call the [[#loop|''loop'']] function after you call the [[#connect|''connect'']] function.
 Returns:

@@ Line 38: / Line 38: @@
 The default log level is 0, meaning nothing is logged.
-If the library is used from LuaUPnP, the logs can be seen in <code>/tmp/log.Init-LuaUPnP</code>.
+If the library is used from LuaUPnP, the logs can be seen in <code>/tmp/log.Init-LuaUPnP</code>
 Parameters:

@@ Line 23: / Line 23: @@
 Parameters:
-* wso (websocket): This is the websocket object returned by the [[#create|create]] function.
+* '''wso''' (websocket): This is the websocket object returned by the [[#create|''create'']] function.
 Returns:
 * nothing

@@ Line 8: / Line 8: @@
 == Functions ==
 === create ===
-Creates a websocket oject, which can be passed to the [[#connect|connect]] function.
+Creates a websocket oject, which must be passed to other functions which require it.
 Parameters:
@@ Line 14: / Line 14: @@
 * '''event_handlers''' (table): A table where the index is the [[#Event_IDs|event ID]], and the value is the callback function name.
 * '''ssl_settings''' (table): A table where the index is the SSL setting name, and the value is the SSL setting value.
-* '''standalone''' (boolean): In ''standalone'' mode the service thread won't be detached, which means that the main thread should wait for the service thread to exit, before exiting itself. This is done by calling the [[#loop|loop]] function from Lua. This mode should be used when the library is loaded from a standalone Lua script, which can afford to block for an undefined amount of time. If the library is loaded from LuaUPnP, ''standalone'' should be '''false''', because LuaUPnP functions can't block for much time, otherwise the watchdog will restart the Luup engine.
+* '''standalone''' (boolean): Set this to '''true''' if using the library from a standalone Lua script, or to '''false''' if using the library from LuaUPnP. If not set, the default value is '''false'''.
 Returns:
-* wso (websocket)
+* '''wso''' (websocket): The websocket object.
 === connect ===

@@ Line 41: / Line 41: @@
 Parameters:
-* log_levels (int or string): log_levels can be either a number, representing a bit mask where each bit is a log level, or the string "all", which means all log levels enabled, and it's the equivalent of setting all the bits in the mask (log_levels = 2047). The available log levels are listed here.
+* '''log_levels''' (int or string): ''log_levels'' can be either a number, representing a bit mask where each bit is a log level, or the string ''"all"'', which means all log levels enabled, and it's the equivalent of setting all the bits in the mask (''log_levels'' = 2047). The available log levels are listed [[#Log_levels|here]].
 <br>
 == Reference ==

@@ Line 1: / Line 1: @@
 == What is ''verawebsockets''? ==
@@ Line 18: / Line 19: @@
 * wso (websocket)
-==== Event IDs ====
+=== connect ===
 Since ''verawebsockets'' is based on the ''libwebsockets'' library, the verawebsockets event IDs are the same as the libwebsockets callback reasons, which are documented here:
@@ Line 30: / Line 56: @@
 ! style="border: 1px solid #000" | Description
 |-
-| style="border: 1px solid #000" | 1
+| style="border: 1px solid #000; text-align: center" | 1
 | style="border: 1px solid #000" | LWS_CALLBACK_CLIENT_CONNECTION_ERROR
 | style="border: 1px solid #000" | Failed to connect to the server. The reason for the failure is passed as parameter to the callback function. Some possible values are:
@@ Line 70: / Line 96: @@
 * HS: Rejected at CLIENT_ESTABLISHED
 |-
-| style="border: 1px solid #000" | 3
+| style="border: 1px solid #000; text-align: center" | 3
 | style="border: 1px solid #000" | LWS_CALLBACK_CLIENT_ESTABLISHED
 | style="border: 1px solid #000" | Called after the connection with the server has been established. No parameter is passed to the callback function.
 |-
-| style="border: 1px solid #000" | 4
+| style="border: 1px solid #000; text-align: center" | 4
 | style="border: 1px solid #000" | LWS_CALLBACK_CLOSED
 | style="border: 1px solid #000" | Called after the websocket connection closed. No parameter is passed to the callback function.
 |-
-| style="border: 1px solid #000" | 8
+| style="border: 1px solid #000; text-align: center" | 8
 | style="border: 1px solid #000" | LWS_CALLBACK_CLIENT_RECEIVE
 | style="border: 1px solid #000" | Called when we receive data from the server. The received data is passed as parameter to the callback function.
 |}
+<br>
-==== SSL settings ====
+=== SSL settings ===
 These are the SSL settings which are currently supported:
-  client_ssl_cert_filepath        : The certificate the client should present to the server on connection.
+{| style="border: 1px solid #000;  border-collapse: collapse"
- client_ssl_private_key_filepath : Filepath to the client private key.
+|-
+! style="border: 1px solid #000" | SSL setting
-=== connect ===
+! style="border: 1px solid #000" | Description
-Connects to the URL from the websocket object.
+|-
+| style="border: 1px solid #000; padding: 0px 10px" | client_ssl_cert_filepath
-Parameters:
+| style="border: 1px solid #000; padding: 0px 10px" | The certificate the client should present to the server on connection.
-* wso (websocket): This is the websocket object returned by the [[#create|create]] function.
+|-
-Returns:
+| style="border: 1px solid #000; padding: 0px 10px" | client_ssl_private_key_filepath
-* nothing
+| style="border: 1px solid #000; padding: 0px 10px" | Filepath to the client private key.
+|}
-=== loop ===
+<br>
-Parameters:
+=== Log levels ===
-* none
+{| style="border: 1px solid #000;  border-collapse: collapse"
-Returns:
+|-
-* nothing
+! style="border: 1px solid #000; padding: 2px 10px" | Log level
+! style="border: 1px solid #000; padding: 2px 10px" | Description
-=== set_log_level ===
+|-
-Parameters:
+| style="border: 1px solid #000; text-align: right; padding-right: 10px" | 1
-* log_levels (int or string)
+| style="border: 1px solid #000; padding-left: 10px" | Error
+|-
 == Further documentation ==
 * The WebSocket protocol: