Final changes for 0.8.4

Author: robotconscience

README.md

@@ -143,11 +143,15 @@ make
 * Version 0.8.4 (current)
 	* + Added iOS library
 	* + Added RPi library (thanks to @rc1)
+	* + Added libwebsockets' rudimentary keep-alive
+		* See issue #38
 	* \ Updated to latest version of libwebsockets
 		* \ Bug fixes for newest libwebsockets version
 	* \ testApp changed to ofApp
 	* \ Better comments in general
 	* \ Removed unnecessary checks for binary support (always enabled in libwebsockets)
+	* \ Removed "of-protocol" protocol from examples (you don't need it!)
+	* + Added adjustable image quality to binary video example for demonstration
 * Version 0.8.1 
 	* Overhauled all messaging, supporting sending/receiving string and binary messages of indefinite size via continuation frames
 	* Added examples from @zebradog of sending Blob data over websockets: way faster, way cleaner!

libs/libwebsockets/lib/osx/libwebsockets.dylib

@@ -50,11 +50,15 @@ namespace ofxLibwebsockets {
         void sendBinary( unsigned char * data, unsigned int size );
         void sendBinary( char * data, unsigned int size );
 
-        void setupAddress();
-        
+        // gets IP address *relative to system*
+        // e.g. localhost could be ::1, 127.0.0.1, your IP, etc...
         std::string getClientIP();
         std::string getClientName();
 
+        // 'private' accessor for static libwebsockets loop stuff
+        
+        void setupAddress();
+        
         libwebsocket_context* context;
         libwebsocket* ws;
         Reactor*  reactor;

libs/ofxLibwebsockets/include/ofxLibwebsockets/Connection.h

@@ -125,7 +125,9 @@ namespace ofxLibwebsockets {
 
     // SERVER CALLBACK
 
-    static int lws_callback(struct libwebsocket_context* context, struct libwebsocket *ws, enum libwebsocket_callback_reasons reason, void *user, void *data, size_t len){
+    static int lws_callback(struct libwebsocket_context* context, struct libwebsocket *ws,
+                            enum libwebsocket_callback_reasons reason, void *user, void *data, size_t len)
+    {
         const struct libwebsocket_protocols* lws_protocol = (ws == NULL ? NULL : libwebsockets_get_protocol(ws));
         int idx = lws_protocol? lws_protocol->protocol_index : 0;   
 
@@ -152,10 +154,12 @@ namespace ofxLibwebsockets {
 
         ofLog( OF_LOG_VERBOSE, "[ofxLibwebsockets] "+ getCallbackReason(reason) );
 
-        // server completed handshake, need to ask for next "writable" callback
         if (reason == LWS_CALLBACK_ESTABLISHED){
+            // server completed handshake, need to ask for next "writable" callback
             libwebsocket_callback_on_writable(context, ws);
 
+            // now is when you can set the "user" data,
+            // which we use to instantiate / refer to the ofxLibwebsockets::Connection
             if ( reactor != NULL ){
                 *conn_ptr = new Connection(reactor, protocol);
             }
@@ -168,25 +172,32 @@ namespace ofxLibwebsockets {
         {
             // we may use these in the future!
             case LWS_CALLBACK_WSI_CREATE:
-            case LWS_CALLBACK_PROTOCOL_INIT:
+            case LWS_CALLBACK_WSI_DESTROY:
 
             case LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION:
+                
             case LWS_CALLBACK_HTTP_BODY_COMPLETION:
             case LWS_CALLBACK_HTTP_FILE_COMPLETION:
             case LWS_CALLBACK_HTTP_WRITEABLE:
+            case LWS_CALLBACK_CLOSED_HTTP:
+                
             case LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED:
 
             case LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED:
+            case LWS_CALLBACK_FILTER_NETWORK_CONNECTION:
                 return 0;
 
             case LWS_CALLBACK_FILTER_HTTP_CONNECTION:
-            case LWS_CALLBACK_FILTER_NETWORK_CONNECTION:
                 if (protocol != NULL ){
-                    return reactor->_allow(ws, protocol, (int)(long)user)? 0 : 1;
+                    // return 0 == allow, 1 == block
+                    return reactor->_allow(ws, protocol, (int)(long)data) ? 0 : 1;
                 } else {
-                    return 1;
+                    return 0;
                 }
 
+            case LWS_CALLBACK_PROTOCOL_INIT:
+                return 0;
+                
             case LWS_CALLBACK_HTTP:
                 return reactor->_http(ws, (char*)data);
 
@@ -201,7 +212,15 @@ namespace ofxLibwebsockets {
             case LWS_CALLBACK_CLIENT_FILTER_PRE_ESTABLISH:
                 return 0;
 
-            default:
+            case LWS_CALLBACK_CLIENT_CONNECTION_ERROR:
+            case LWS_CALLBACK_ESTABLISHED:
+            case LWS_CALLBACK_CLIENT_ESTABLISHED:
+            case LWS_CALLBACK_CLOSED:
+            case LWS_CALLBACK_SERVER_WRITEABLE:
+            case LWS_CALLBACK_CLIENT_WRITEABLE:
+            case LWS_CALLBACK_RECEIVE:              // server receive
+            case LWS_CALLBACK_CLIENT_RECEIVE:       // client receive
+            case LWS_CALLBACK_CLIENT_RECEIVE_PONG:
                 if ( user != NULL ){
                     conn = *(Connection**)user;
                 }
@@ -215,9 +234,12 @@ namespace ofxLibwebsockets {
                 } else {
                     return 0;
                 }
+                
+            default:
+                break;
         }
 
-        return 1; // FAIL (e.g. unhandled case/break in switch)
+        return 0;
     }
 
     static void dump_handshake_info(struct lws_tokens *lwst)

libs/ofxLibwebsockets/include/ofxLibwebsockets/Util.h

@@ -97,6 +97,13 @@ namespace ofxLibwebsockets {
         info.extensions = libwebsocket_get_internal_extensions();
         info.gid = -1;
         info.uid = -1;
+        
+        if ( options.ka_time != 0 ){
+            ofLogVerbose()<<"[ofxLibwebsockets] Setting timeout "<<options.ka_time;
+            info.ka_time = options.ka_time;
+            info.ka_probes = options.ka_probes;
+            info.ka_interval = options.ka_interval;
+        }
 
         context = libwebsocket_create_context(&info);
 

libs/ofxLibwebsockets/src/Client.cpp

@@ -92,7 +92,7 @@ namespace ofxLibwebsockets {
         std::string client_ip(128, 0);
         std::string client_name(128, 0);
 
-        libwebsockets_get_peer_addresses(context, ws, (int)fd,
+        libwebsockets_get_peer_addresses(context, ws, libwebsocket_get_socket_fd(ws),
                                          &client_name[0], client_name.size(),
                                          &client_ip[0], client_ip.size());
         return protocol->_allowClient(client_name, client_ip);
@@ -139,14 +139,18 @@ namespace ofxLibwebsockets {
 
             // last thing that happens before connection goes dark
             case LWS_CALLBACK_WSI_DESTROY:
+            {
+                bool bFound = false;
                 for (int i=0; i<connections.size(); i++){
                     if ( connections[i] == conn ){
+                        bFound = true; // valid connection
                         connections.erase( connections.begin() + i );
                         break;
                     }
                 }
 
-                ofNotifyEvent(conn->protocol->oncloseEvent, args);
+                if ( bFound ) ofNotifyEvent(conn->protocol->oncloseEvent, args);
+            }
                 break;
 
             case LWS_CALLBACK_ESTABLISHED:          // server connected with client

libs/ofxLibwebsockets/src/Reactor.cpp

@@ -106,6 +106,13 @@ namespace ofxLibwebsockets {
         info.ssl_private_key_filepath = sslKey;
         info.gid = -1;
         info.uid = -1;
+        
+        if ( options.ka_time != 0 ){
+            info.ka_time = options.ka_time;
+            info.ka_probes = options.ka_probes;
+            info.ka_interval = options.ka_interval;
+        }
+        
         info.options = opts;
 
         context = libwebsocket_create_context(&info);