libt2n: (gerd) improve docu, cleanup for public release

[libt2n] / src / server.hxx

diff --git a/src/server.hxx b/src/server.hxx
index aca705b..f3ace10 100644 (file)
--- a/src/server.hxx
+++ b/src/server.hxx
@@ -56,6 +56,9 @@ class server_connection : public connection
         void set_id(unsigned int _connection_id)
             { connection_id=_connection_id; }
 
+        /// vector initialized for all callback-types, all elements in each list will be called
+        std::vector<std::list<boost::function<void ()> > > callbacks;
+
     protected:
         server *my_server;
 
@@ -63,7 +66,11 @@ class server_connection : public connection
 
         std::ostream* get_logstream(log_level_values level);
 
+        void do_callbacks(callback_event_type event);
+
     public:
+        virtual ~server_connection();
+
         void check_timeout();
         void reset_timeout();
         void set_timeout(int _timeout)
@@ -72,6 +79,10 @@ class server_connection : public connection
         /// get the id of this connection within the server object
         unsigned int get_id()
             { return connection_id; }
+
+        void close();
+
+        void add_callback(callback_event_type event, const boost::function<void ()>& func);
 };
 
 /**
@@ -87,7 +98,7 @@ class server
         std::ostream *logstream;
 
         /// vector initialized for all callback-types, all elements in each list will be called
-        std::vector<std::list<boost::function<void (server_connection*)> > > callbacks;
+        std::vector<std::list<boost::function<void (unsigned int)> > > callbacks;
 
         unsigned int next_id;
 
@@ -100,7 +111,7 @@ class server
 
         int add_connection(server_connection* newconn);
 
-        void do_callbacks(callback_event_type event, server_connection* conn);
+        void do_callbacks(callback_event_type event, unsigned int conn_id);
 
     public:
         virtual ~server();
@@ -117,16 +128,18 @@ class server
 
         server_connection* get_connection(unsigned int conn_id);
 
-        void add_callback(callback_event_type event, const boost::function<void (server_connection*)>& func);
+        void add_callback(callback_event_type event, const boost::function<void (unsigned int)>& func);
 
-        /** @brief look for new data on all open connections, accept new connections
+        /** @brief look for new data and store it in the local buffer
             @param usec_timeout wait until new data is found, max timeout usecs.
                   -1: wait endless
-                   NULL: no timeout
+                   0: return instantly
+            @param usec_timeout_remaining if non-NULL the function will write the
+                  not used time to the given target
             @retval true if new data was found (does not mean that the received data 
                     is a complete packet though)
         */
-        virtual bool fill_buffer(long long usec_timeout=-1)=0;
+        virtual bool fill_buffer(long long usec_timeout=-1, long long* timeout_remaining=NULL)=0;
 
         void cleanup();