rudesocket(3)

📦 version 1.3.0, in fedora 43, fedora 44

🌸 rudesocket — the C++ socket bestie you've been looking for 💅

okay so bestie, we're in rudesocket(3) territory, part of the User Manuals collection. this is the C++ API for making client socket connections and honestly? she's giving main character energy. let's get into it ✨

✨ NAME ✨

rudesocket — a Library (C++ API) for making Client Socket Connections 🦋

✨ SYNOPSIS ✨

     #include <rude/socket.h>

    rude::Socket *socket = new Socket();
    socket->connect('example.com', 80);
    socket->sends('GET / HTTP/1.00);
    const char *response = socket->reads();
    cout << response;
    socket->close();

💖 Public Member Functions 💖

  • Socket () — Constructor. baby's first socket 🎀
  • ~Socket () — Destructor. say bye bestie 👋
  • void setTimeout (int seconds, int microseconds) — sets how long Connect, Read and Send operations are allowed to hang around waiting 💅
  • const char * getError () — hands you a description of the last known error, so you know exactly what went wrong 😭
  • bool connect (const char *server, int port) — connects to the server and port you specify 🫶
  • bool connectSSL (const char *server, int port) — same deal but the connection is secure 🔒✨
  • bool connectSSL (const char *server, int port) — (yes, over a secure connection, we said what we said 💜)
  • bool insertTunnel (const char *server, int port) — slips a transparent tunnel into the connect chain 🌈
  • bool insertSocks5 (const char *server, int port, const char *username, const char *password) — slips a Socks5 server into the connect chain 🧦
  • bool insertSocks4 (const char *server, int port, const char *username) — slips a Socks4 server into the connect chain 🧦
  • bool insertProxy (const char *server, int port) — slips a CONNECT-Enabled HTTP proxy into the connect chain 🛰️
  • int send (const char *data, int length) — sends a whole buffer of data over the connection 📤
  • int read (char *buffer, int length) — reads a buffer of data off the connection 📥
  • const char * reads () — reads everything that's available from the connection, greedy queen 👑
  • const char * readline () — reads just one line from the connection ✏️
  • bool sends (const char *buffer) — sends a null terminated string over the connection 💌
  • bool close () — closes the connection, we're done here 🚪
  • void setMessageStream (std::ostream &o) — sets an output stream to receive real-time messages about the socket, like a little live commentary feed 📡
lowkey important note: that list above is the exact roster from the original, and no, I did not merge the two connectSSL lines — they were both there, so they're both here. no cap. 💀

✨ Detailed Description ✨

The public interface to the Socket component. that's her. that's the whole vibe 🫶

If you are using windows, you will need to initiate the winsock DLL yourself, and finish the DLL yourself when you are done using the component. like, nobody's gonna do it for you bestie, you gotta do your own winsock homework 🌸

✨ General Usage ✨

    Socket *socket = new Socket();
    socket->connect('example.com', 80);
    socket->sends('GET / HTTP/1.00);
    const char *response = socket->reads();
    cout << response;
    socket->close();

🔒 SSL Usage 🔒

    Socket *socket = new Socket();
    socket->connectSSL('example.com', 443);
    socket->sends('GET / HTTP/1.00);
    const char *response = socket->reads();
    cout << response;
    socket->close();

🔗 Chaining Connections 🔗

okay this is the part where it gets ✨iconic✨ — you stack up your hops and she walks the whole chain:

    Socket *socket = new Socket();
    socket->insertSocks4('12.34.56.78', 8000, 'username');
    socket->insertSocks5('12.34.56.78', 8000, 'username', 'password');
    socket->insertProxy('12.34.56.78', 8080);
    socket->connectSSL('example.com', 443);
    socket->sends('GET / HTTP/1.00);
    const char *response = socket->reads();
    cout << response;
    socket->close();

🚨 Adding Error checking 🚨

the glow-up where you stop living dangerously and start checking your return values:

    Socket *socket = new Socket();
    if(socket->connectSSL('google.com', 443))
    {
        if(socket->sends('GET / HTTP/1.00))
        {
            const char *response = socket->reads();
            if(response)
            {
                cout << response;
            }
            else
            {
                cout << socket->getError() << '0;
            }
        }
        else
        {
            cout << socket->getError() << '0;
        }
        socket->close();
    }
    else
    {
        cout << socket->getError() << '0;
    }

✨ Constructor & Destructor Documentation ✨

🎀 rude::Socket::Socket ()

Constructor. she is born 💖

🎀 rude::Socket::~Socket ()

Destructor. she is gone 😭

✨ Member Function Documentation ✨

💅 bool rude::Socket::close ()

Closes the connection.

A connection must established before this method can be called. like, you can't close something that was never open, bestie 🙈

💅 bool rude::Socket::connect (const char * server, int port)

Connects to the specified server and port.

If proxies have been specified, the connection passes through tem first. (typo's theirs, love that for them 🫶)

💅 bool rude::Socket::connectSSL (const char * server, int port)

Connects to the specified server and port over a secure connection.

If proxies have been specified, the connection passes through them first.

💅 const char* rude::Socket::getError ()

Returns a description of the last known error. receipts, basically 🧾

💅 bool rude::Socket::insertProxy (const char * server, int port)

Inserts a CONNECT-Enabled HTTP proxy into the connect chain.

Becomes the last server connected to in the chain before connecting to the destination server. she queues up right at the front of the line 👑

💅 bool rude::Socket::insertSocks4 (const char * server, int port, const char * username)

Inserts a Socks4 server into the connect chain.

Becomes the last server connected to in the chain before connecting to the destination server.

💅 bool rude::Socket::insertSocks5 (const char * server, int port, const char * username, const char * password)

Inserts a Socks5 server into the connect chain.

Becomes the last server connected to in the chain before connecting to the destination server.

💅 bool rude::Socket::insertTunnel (const char * server, int port)

Inserts a transparent tunnel into the connect chain.

A transparent Tunnel is a server that accepts a connection on a certain port, and always connects to a particular server:port address on the other side. Becomes the last server connected to in the chain before connecting to the destination server. so it's a no-thoughts-just-forwarding situation 🌀

💅 int rude::Socket::read (char * buffer, int length)

Reads a buffer of data from the connection.

A connection must established before this method can be called.

💅 const char* rude::Socket::readline ()

Reads a line from the connection.

A connection must established before this method can be called.

💅 const char* rude::Socket::reads ()

Reads everything available from the connection.

A connection must established before this method can be called.

💅 int rude::Socket::send (const char * data, int length)

Sends a buffer of data over the connection.

A connection must established before this method can be called.

💅 bool rude::Socket::sends (const char * buffer)

Sends a null terminated string over the connection.

The string can contain its own newline characters. Returns false and sets the error message if it fails to send the line. A connection must established before this method can be called.

bestie note: yes, if it fails it returns false and sets the error message — so go read getError() after. it's giving "I told you so" 💀

💅 void rude::Socket::setMessageStream (std::ostream & o)

Sets an output stream to receive real-time messages about the socket. live tweeting, but for sockets 📡✨

💅 void rude::Socket::setTimeout (int seconds, int microseconds)

Sets the timeout value for Connect, Read and Send operations.

Setting the timeout to 0 removes the timeout - making the Socket blocking. so zero means "wait forever", not "give up instantly" — read that twice 🔥

✨ SEE ALSO ✨

rudecgiparser(3), rudeconfig(3), rudedatabase(3), rudesession(3) — the whole rude family, go say hi 🫶💜

✨ REPORTING PROBLEMS ✨

Before reporting a problem, please check the rudeserver.com web site to verify that you have the latest version of rudesocket; otherwise, obtain the latest version and see if the problem still exists. Please read the FAQ at:

                     http://www.rudeserver.com/

before asking for help. Send questions and/or comments to matt@rudeserver.com 💌

✨ AUTHORS ✨

Copyright (C) 2000-2008 Matthew Flood (matt@rudeserver.com)

This software is provided "as-is," without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software. See the distribution directory with respect to requirements governing redistribution. Thanks to all the people who reported problems and suggested various improvements in rudesocket; who are too numerous to cite here. 🌈👑

and that's the whole page bestie!! this was Version 1.1.0, dated 15 Jan 2008 — yeah she's an elder but she still ate 💅✨ go make some sockets, ily, bye 🫶🎀

📦 where this page comes from