Merge pull request #28 from stewpend0us/master

optionally expose the internal buffer size to the user (if they need it)
eminfedar · May 12, 2023 · d66588d · d66588d
2 parents 1ecd626 + c3440df
commit d66588d
Show file tree

Hide file tree

Showing 10 changed files with 40 additions and 32 deletions.
diff --git a/async-sockets/include/basesocket.hpp b/async-sockets/include/basesocket.hpp
@@ -17,6 +17,10 @@
 #define FDR_UNUSED(expr){ (void)(expr); } 
 #define FDR_ON_ERROR std::function<void(int, std::string)> onError = [](int errorCode, std::string errorMessage){FDR_UNUSED(errorCode); FDR_UNUSED(errorMessage)}
 
+#ifndef AS_DEFAULT_BUFFER_SIZE
+#define AS_DEFAULT_BUFFER_SIZE 0x1000 /*4096 bytes*/
+#endif
+
 class BaseSocket
 {
 public:
@@ -26,7 +30,6 @@ class BaseSocket
         UDP = SOCK_DGRAM
     };
     sockaddr_in address;
-    constexpr static uint16_t BUFFER_SIZE = 0x1000; // 4096 bytes
 
     void Close() {
         shutdown(this->sock, SHUT_RDWR);

diff --git a/async-sockets/include/tcpserver.hpp b/async-sockets/include/tcpserver.hpp
@@ -3,11 +3,12 @@
 #include "tcpsocket.hpp"
 #include <thread>
 
+template <uint16_t BUFFER_SIZE = AS_DEFAULT_BUFFER_SIZE>
 class TCPServer : public BaseSocket
 {
 public:
     // Event Listeners:
-    std::function<void(TCPSocket*)> onNewConnection = [](TCPSocket* sock){FDR_UNUSED(sock)};
+    std::function<void(TCPSocket<BUFFER_SIZE>*)> onNewConnection = [](TCPSocket<BUFFER_SIZE>* sock){FDR_UNUSED(sock)};
 
     explicit TCPServer(FDR_ON_ERROR): BaseSocket(onError, SocketType::TCP)
     {
@@ -57,7 +58,7 @@ class TCPServer : public BaseSocket
     }
 
 private:
-    static void Accept(TCPServer* server, FDR_ON_ERROR)
+    static void Accept(TCPServer<BUFFER_SIZE>* server, FDR_ON_ERROR)
     {
         sockaddr_in newSocketInfo;
         socklen_t newSocketInfoLength = sizeof(newSocketInfo);
@@ -75,7 +76,7 @@ class TCPServer : public BaseSocket
                 return;
             }
 
-            TCPSocket* newSocket = new TCPSocket(onError, newSocketFileDescriptor);
+            TCPSocket<BUFFER_SIZE>* newSocket = new TCPSocket<BUFFER_SIZE>(onError, newSocketFileDescriptor);
             newSocket->deleteAfterClosed = true;
             newSocket->setAddressStruct(newSocketInfo);
 

diff --git a/async-sockets/include/tcpsocket.hpp b/async-sockets/include/tcpsocket.hpp
@@ -6,6 +6,7 @@
 #include <functional>
 #include <thread>
 
+template <uint16_t BUFFER_SIZE = AS_DEFAULT_BUFFER_SIZE>
 class TCPSocket : public BaseSocket
 {
 public:
@@ -95,10 +96,10 @@ class TCPSocket : public BaseSocket
 private:
     static void Receive(TCPSocket* socket)
     {
-        char tempBuffer[TCPSocket::BUFFER_SIZE];
+        char tempBuffer[BUFFER_SIZE];
         ssize_t messageLength;
 
-        while ((messageLength = recv(socket->sock, tempBuffer, TCPSocket::BUFFER_SIZE, 0)) > 0)
+        while ((messageLength = recv(socket->sock, tempBuffer, BUFFER_SIZE, 0)) > 0)
         {
             tempBuffer[messageLength] = '\0';
             if(socket->onMessageReceived)

diff --git a/async-sockets/include/udpserver.hpp b/async-sockets/include/udpserver.hpp
@@ -3,7 +3,8 @@
 #include "udpsocket.hpp"
 #include <thread>
 
-class UDPServer : public UDPSocket
+template <uint16_t BUFFER_SIZE = AS_DEFAULT_BUFFER_SIZE>
+class UDPServer : public UDPSocket<BUFFER_SIZE>
 {
 public:
     // Bind the custom address & port of the server.

diff --git a/async-sockets/include/udpsocket.hpp b/async-sockets/include/udpsocket.hpp
@@ -4,6 +4,7 @@
 #include <string.h>
 #include <thread>
 
+template <uint16_t BUFFER_SIZE = AS_DEFAULT_BUFFER_SIZE>
 class UDPSocket : public BaseSocket
 {
 public:
@@ -14,7 +15,6 @@ class UDPSocket : public BaseSocket
     {
         if (useConnect)
         {
-
             std::thread t(Receive, this); // usage with Connect()
             t.detach();
         }
@@ -135,10 +135,10 @@ class UDPSocket : public BaseSocket
 private:
     static void Receive(UDPSocket* udpSocket)
     {
-        char tempBuffer[UDPSocket::BUFFER_SIZE];
+        char tempBuffer[BUFFER_SIZE];
         ssize_t messageLength;
 
-        while ((messageLength = recv(udpSocket->sock, tempBuffer, UDPSocket::BUFFER_SIZE, 0)) != -1)
+        while ((messageLength = recv(udpSocket->sock, tempBuffer, BUFFER_SIZE, 0)) != -1)
         {
             tempBuffer[messageLength] = '\0';
             if (udpSocket->onMessageReceived)
@@ -154,10 +154,10 @@ class UDPSocket : public BaseSocket
         sockaddr_in hostAddr;
         socklen_t hostAddrSize = sizeof(hostAddr);
 
-        char tempBuffer[UDPSocket::BUFFER_SIZE];
+        char tempBuffer[BUFFER_SIZE];
         ssize_t messageLength;
 
-        while ((messageLength = recvfrom(udpSocket->sock, tempBuffer, UDPSocket::BUFFER_SIZE, 0, (sockaddr* )&hostAddr, &hostAddrSize)) != -1)
+        while ((messageLength = recvfrom(udpSocket->sock, tempBuffer, BUFFER_SIZE, 0, (sockaddr* )&hostAddr, &hostAddrSize)) != -1)
         {
             tempBuffer[messageLength] = '\0';
             if (udpSocket->onMessageReceived)

diff --git a/examples/Makefile b/examples/Makefile
@@ -1,25 +1,27 @@
 CC		:= g++
 CFLAGS	:= --std=c++11 -Wall -Wextra -Werror=conversion
 LIBS	:= -lpthread
-INC		:= -I../async-sockets/include
+INC		:= ../async-sockets/include
 RM		:= rm
 
+.PHONY: all clean
+
 all: tcp-client tcp-server udp-client udp-server
 
-tcp-client:
-	$(CC) $(CFLAGS) tcp-client.cpp $(INC) $(LIBS) -o tcp-client
+tcp-client: tcp-client.cpp $(INC)/tcpsocket.hpp
+	$(CC) $(CFLAGS) $< -I$(INC) $(LIBS) -o $@
 
-tcp-server:
-	$(CC) $(CFLAGS) tcp-server.cpp $(INC) $(LIBS) -o tcp-server
+tcp-server: tcp-server.cpp $(INC)/tcpserver.hpp
+	$(CC) $(CFLAGS) $< -I$(INC) $(LIBS) -o $@
 
-udp-client:
-	$(CC) $(CFLAGS) udp-client.cpp $(INC) $(LIBS) -o udp-client
+udp-client: udp-client.cpp $(INC)/udpsocket.hpp
+	$(CC) $(CFLAGS) $< -I$(INC) $(LIBS) -o $@
 
-udp-server:
-	$(CC) $(CFLAGS) udp-server.cpp $(INC) $(LIBS) -o udp-server
+udp-server: udp-server.cpp $(INC)/udpserver.hpp
+	$(CC) $(CFLAGS) $< -I$(INC) $(LIBS) -o $@
 
 clean:
 	$(RM) tcp-client
 	$(RM) tcp-server
 	$(RM) udp-client
-	$(RM) udp-server
+	$(RM) udp-server
diff --git a/examples/tcp-client.cpp b/examples/tcp-client.cpp
@@ -1,12 +1,12 @@
-#include "../async-sockets/include/tcpsocket.hpp"
+#include "tcpsocket.hpp"
 #include <iostream>
 
 using namespace std;
 
 int main()
 {
     // Initialize socket.
-    TCPSocket tcpSocket([](int errorCode, std::string errorMessage){
+    TCPSocket<> tcpSocket([](int errorCode, std::string errorMessage){
         cout << "Socket creation error:" << errorCode << " : " << errorMessage << endl;
     });
 
@@ -25,7 +25,7 @@ int main()
         cout << "Connection closed: " << errorCode << endl;
     };
 
-    // Connect to the host.
+    // Connect to the host (with a custom buffer size).
     tcpSocket.Connect("localhost", 8888, [&] {
         cout << "Connected to the server successfully." << endl;
 

diff --git a/examples/tcp-server.cpp b/examples/tcp-server.cpp
@@ -1,15 +1,15 @@
-#include "../async-sockets/include/tcpserver.hpp"
+#include "tcpserver.hpp"
 #include <iostream>
 
 using namespace std;
 
 int main()
 {
     // Initialize server socket..
-    TCPServer tcpServer;
+    TCPServer<> tcpServer;
 
     // When a new client connected:
-    tcpServer.onNewConnection = [&](TCPSocket *newClient) {
+    tcpServer.onNewConnection = [&](TCPSocket<> *newClient) {
         cout << "New client: [";
         cout << newClient->remoteAddress() << ":" << newClient->remotePort() << "]" << endl;
 

diff --git a/examples/udp-client.cpp b/examples/udp-client.cpp
@@ -1,4 +1,4 @@
-#include "../async-sockets/include/udpsocket.hpp"
+#include "udpsocket.hpp"
 #include <iostream>
 
 using namespace std;
@@ -10,7 +10,7 @@ int main()
     constexpr uint16_t PORT = 8888;
 
     // Initialize socket.
-    UDPSocket udpSocket(true); // "true" to use Connection on UDP. Default is "false".
+    UDPSocket<100> udpSocket(true); // "true" to use Connection on UDP. Default is "false".
     udpSocket.Connect(IP, PORT);
 
     // Send String:

diff --git a/examples/udp-server.cpp b/examples/udp-server.cpp
@@ -1,12 +1,12 @@
-#include "../async-sockets/include/udpserver.hpp"
+#include "udpserver.hpp"
 #include <iostream>
 
 using namespace std;
 
 int main()
 {
     // Initialize server socket..
-    UDPServer udpServer;
+    UDPServer<> udpServer;
 
     // onMessageReceived will run when a message received with information of ip & port of sender:
     /*udpServer.onMessageReceived = [&](string message, string ipv4, uint16_t port) {