Efficient Network Streamer for MOOSE (#352)

* This version shows images perfectly well. do not use timestamp since their value
will not compare with timestamp of artifacts on different machines.

* Temp commit.

* CTRL+C is still not behaving well.

* Socket information is separated and stored in one class.

* os.file.isfile does not work with UNIX_DOMAIN_SOCKET. use os.path.exists.

* Working version. Good for demo.

* Updated a little.

* Streaming is now flawless.

* passes.

* Local tests passes.

* Good for demo.

* Squashed commit of the following:

commit 33fd75bf051e4799d2c37d3dc6cd59d3bbd73f42
Author: Dilawar Singh <[email protected]>
Date:   Sat Feb 9 17:48:43 2019 +0530

    Working fantastically with multiprocessing.

commit 3fd5a8724e7b9cc0c681f44f4019ecb3844129eb
Author: Dilawar Singh <[email protected]>
Date:   Sat Feb 9 16:29:59 2019 +0530

    Split connect and stream function into two.

* A decent working version.

* updated a little bit more.

* Small simulation do not steam all the data. Large simulations are
working fine.

* Working version. May be SocketStreamer is ticking too fast.

* faster tests; non-blocking client.

* use absolute import | python3 error in build.

* folder name changed for reflect if PYTHON3 is being used.

* Added some delay after start()

* Fixes for OSX.

* The last table is allowed to have slightly fewer elements.

* Some more improvement.

Author: dilawar

.travis/travis_build_linux.sh

@@ -58,14 +58,14 @@ if type $PYTHON3 > /dev/null; then
     sudo apt-get install -qq python3-networkx || echo "Error with apt"
     # GSL.
     (
-        mkdir -p _GSL_BUILD2 && cd _GSL_BUILD2 && \
+        mkdir -p _GSL_BUILD_PY3 && cd _GSL_BUILD_PY3 && \
             cmake -DPYTHON_EXECUTABLE="$PYTHON3" -DDEBUG=ON ..
         $MAKE && ctest --output-on-failure
     )
 
     # BOOST
     (
-        mkdir -p _BOOST_BUILD2 && cd _BOOST_BUILD2 && \
+        mkdir -p _BOOST_BUILD_PY3 && cd _BOOST_BUILD_PY3 && \
             cmake -DWITH_BOOST_ODE=ON -DPYTHON_EXECUTABLE="$PYTHON3" ..
         $MAKE && ctest --output-on-failure
     )

basecode/ObjId.cpp

@@ -112,8 +112,9 @@ bool ObjId::isOffNode() const
 
 char* ObjId::data() const
 {
-    return id.element()->data( id.element()->rawIndex( dataIndex ),
-                               fieldIndex );
+    return id.element()->data(
+            id.element()->rawIndex( dataIndex ), fieldIndex 
+        );
 }
 
 string ObjId::path() const

builtins/MooseSocketInfo.h

@@ -0,0 +1,83 @@
+/*
+ *    Description:  Utility class for handling socket.
+ *         Author:  Dilawar Singh (), [email protected]
+ *   Organization:  NCBS Bangalore
+ */
+
+#ifndef MOOSESOCKETINFO_H
+#define MOOSESOCKETINFO_H
+
+typedef enum t_socket_type_ {TCP_SOCKET, UNIX_DOMAIN_SOCKET} SocketType; // Type of socket.
+
+class MooseSocketInfo
+{
+public:
+    MooseSocketInfo( const string& addr = "" )
+        : address(addr), valid(false)
+    {
+        if( addr.size() > 0 )
+            init();
+    }
+
+    ~MooseSocketInfo() { ; }
+
+    void setAddress( const string addr )
+    {
+        address = addr;
+        init();
+    }
+
+    void init( void )
+    {
+        if( "file://" == address.substr(0, 7))
+        {
+            type = UNIX_DOMAIN_SOCKET;
+            filepath = address.substr(7);
+            valid = true;
+        }
+        else if( "http://" == address.substr(0, 7))
+        {
+            type = TCP_SOCKET;
+            auto colPos = address.find_last_of(':');
+            if( colPos == string::npos )
+            {
+                port = 0;
+                host = address;
+            }
+            else
+            {
+                host = address.substr(0, colPos);
+                port = std::stoi(address.substr(colPos+1));
+            }
+            valid = true;
+        }
+        else if( '/' == address[0] )
+        {
+            type = UNIX_DOMAIN_SOCKET;
+            filepath = address;
+            valid = true;
+        }
+    }
+
+    // C++ is so stupid: https://stackoverflow.com/q/476272/1805129
+    friend std::ostream& operator<<(ostream& os, const MooseSocketInfo& info)
+    {
+        os << "ADDRESS= " << info.address << " TYPE= " << info.type;
+        if( info.type == UNIX_DOMAIN_SOCKET)
+            os << ". FILEPATH " << info.filepath;
+        else
+            os << ". HOST:PORT=" << info.host << ":" << info.port;
+        return os;
+    }
+
+public:
+    SocketType type;
+    string address;
+    string filepath;
+    string host;
+    bool valid;
+    size_t port;
+};
+
+
+#endif /* end of include guard: MOOSESOCKETINFO_H */