-/***************************************************************************
- * Copyright (C) 2006 by Gerd v. Egidy *
- * gve@intra2net.com *
- * *
- * This library is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU Lesser General Public License version *
- * 2.1 as published by the Free Software Foundation. *
- * *
- * This library is distributed in the hope that it will be useful, *
- * but WITHOUT ANY WARRANTY; without even the implied warranty of *
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
- * GNU Lesser General Public License for more details. *
- * *
- * You should have received a copy of the GNU Lesser General Public *
- * License along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
- ***************************************************************************/
+/*
+Copyright (C) 2006 by Intra2net AG - Gerd v. Egidy
+
+The software in this package is distributed under the GNU General
+Public License version 2 (with a special exception described below).
+
+A copy of GNU General Public License (GPL) is included in this distribution,
+in the file COPYING.GPL.
+
+As a special exception, if other files instantiate templates or use macros
+or inline functions from this file, or you compile this file and link it
+with other works to produce a work based on this file, this file
+does not by itself cause the resulting work to be covered
+by the GNU General Public License.
+
+However the source code for this file must still be made available
+in accordance with section (3) of the GNU General Public License.
+
+This exception does not invalidate any other reasons why a work based
+on this file might be covered by the GNU General Public License.
+*/
#ifndef __LIBT2N_SOCKET_SERVER
#define __LIBT2N_SOCKET_SERVER
namespace libt2n
{
-/**
- Socket based server class
+class socket_server_connection;
+
+/** @brief Socket based server class
+
+ Use this class to instantiate a server listening for client connections.
+ Call fill_buffer() to read data from the network and get_packet() to retrieve
+ this data. Don't forget to call cleanup() from time to time to remove closed
+ connections and close idle ones.
*/
class socket_server : public socket_handler, public server
{
+ friend class socket_server_connection;
+
private:
fd_set connection_set;
std::string unix_path;
+ void start_listening();
+
void new_connection();
+ bool fill_connection_buffers();
+ void remove_connection_socket(int sock);
+
protected:
- void log(log_level_values level, const std::string& message)
- { log(level,message.c_str()); }
- void log(log_level_values level, const char* message)
- { server::log(level,message); }
+ std::ostream* get_logstream(log_level_values level)
+ { return server::get_logstream(level); }
public:
socket_server(int port, const std::string& ip="0.0.0.0");
~socket_server();
- void fill_buffer(long long usec_timeout=-1);
- void fill_connection_buffers();
-
- void remove_connection_socket(int sock);
+ bool fill_buffer(long long usec_timeout=-1,long long* usec_timeout_remaining=NULL);
};
-/**
- Socket based connection class
+/** @brief Socket based connection
+
+ This class is used within a socket_server to represent the connection to each client.
*/
class socket_server_connection : public socket_handler, public server_connection
{
: server_connection(_timeout), socket_handler(_sock,_stype)
{ }
- void log(log_level_values level, const char* message);
+ ~socket_server_connection();
+
+ std::ostream* get_logstream(log_level_values level)
+ { return server_connection::get_logstream(level); }
void real_write(const std::string& data)
{ socket_write(data); }
public:
- void fill_buffer(long long usec_timeout=-1)
- { socket_handler::fill_buffer(buffer,usec_timeout); }
+ bool fill_buffer(long long usec_timeout=-1,long long* usec_timeout_remaining=NULL)
+ { return socket_handler::fill_buffer(buffer,usec_timeout,usec_timeout_remaining); }
- void close();
+ virtual void close();
};
}