sock_connect

Wrapper for linux TCP/UDP/unix/USB socket connections

Programming language: C++

License: MIT License

Tags: Networking     Library     Socket    

README

Socket Connection wrapper shared library

Shared library that realize sockets connections and could transfer data-packages.

Navigation

• Navigation
• Installation
• Usage
• Examples
• Variations
• License

Installation:

---

Compile from source

• git clone https://github.com/DGolgovsky/sock_connect.git clone git repository
• cd sock_connect change directory to cloned repo-dir
• ./ci-build.sh -r compile latest release version
• also you can use ./ci-build.sh -h for print help information for another variations of building
• cd build jump to directory with compiled objects
• sudo make install install library as root

Package provides headers installs at /usr/include and .so library, puts to /usr/lib

Usage:

---

• Include header in your source files where do you need it.

#include <sock_connect.h>

• Compile with -lsock_connect

Variations:

---

1. Connection with TCP transmission
   • auto tcp = std::make_shared<Connector<TCP>>(IP, PORT);
2. Connection with UDP transmission
   • auto udp = std::make_shared<Connector<UDP>>(INADDR_ANY, PORT);
3. Connection with UNIX-domain sockets transmission
   • auto unix = std::make_shared<Connector<UNIX>>(sun_path);
4. Connection with USB transmission
   • auto usb = std::make_shared<Connector<USB>>(dev_path, speed);
5. DEPRECATED Transform const char* ip-addr 192.168.1.42 to uint32_t
   • uint32_t IP = ip_to_int(argv[1]);

Examples:

---

• Receiving TCP as client:

uint16_t msg = 0;
auto recv_sz = sizeof(uint16_t);

/* Create new socket connection */
auto tcp = std::make_shared<Connector<TCP>>(IP, PORT);
while (tcp->Status()) {
    // While tcp establish connection to server
    if (tcp->Connect()) {
        // While data receiving do something with it
        // if tcp connection lost tcp->Receive returns false
        while (tcp->Receive(&msg, recv_sz)) {
            // do_something with received data
            // ...
        }
        // Trying reconnect if connection lost
        tcp.reset(new Connector<TCP>(IP, PORT));
    }
}

• Receiving TCP as multi-server:

template<class T>
void handler(T tcp, int client_id) {
    tcp->assign_thread(client_id);
    uint16_t msg = 0;
    auto recv_sz = sizeof(uint16_t);
    while ((tcp->Receive(&msg, recv_sz))) {
        // do_something with received message
        // ...
    }
    tcp->Shutdown(client_id);
}

/* Used if [this] - recv server */
void receiver()
{
    /* Creating new connection */
    auto tcp = std::make_shared<Connector<TCP>>(IP, PORT);

    tcp->Bind(false); /* You can use it as TCP->Bind(); for bind && listen */
    tcp->Listen(); /* You may don't need this part if you bind with (true) option */

    int client_id = 0;
    while ((client_id = tcp->Accept()) > 0) {
        /* Accepting new connections and start receiving with the new thread */
        std::thread thread(handler<decltype(tcp)>, tcp, client_id);
        thread.detach();
    }
}

• Sending TCP as client to server, broadcasting UDP:

auto tcp = std::make_shared<Connector<TCP>>(INADDR_LOOPBACK, PORT); // 127.0.0.1
auto udp = std::make_shared<Connector<UDP>>(INADDR_ANY, PORT); // 0.0.0.0

uint16_t msg = 0;
auto msg_sz = sizeof(uint16_t);

// Infinite loop. This allow execute tcp_sender as daemon
while (true) {
    if (tcp->Connect()) {
        // If connection successful,
        // send data while Status() returns true
        while (tcp->Status()) {
            msg = rand() % 50; // Generate random data
            if (msg) {
                // Trying to send message
                // Continue if sending is failure,
                // Also tcp->Status() will return false
                if (!tcp->Send(&msg, msg_sz)) continue;
                // Send udp package
                udp->Send(&msg, msg_sz);                
            }
        }
        // Reconnecting if connection lost
        tcp.reset(new Connector<TCP>(INADDR_LOOPBACK, PORT));
    }
}

License:

---

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[MIT License](../blob/master/LICENSE)