Add main page for Doxygen generated documentation.
[tairent.git] / src / core / netthread.h
blob8a5d523470c3ffb0ad9cafc1a02a303f7b4c90f7
1 /***************************************************************************
2 * *
3 * Copyright (C) 2006 David Brodsky *
4 * *
5 * This program is free software; you can redistribute it and/or *
6 * modify it under the terms of the GNU General Public License as *
7 * published by the Free Software Foundation and appearing *
8 * in the file LICENSE.GPL included in the packaging of this file. *
9 * *
10 * This program is distributed in the hope that it will be useful, *
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
13 * General Public License for more details. *
14 * *
15 ***************************************************************************/
17 #ifndef _core_netthread_h
18 #define _core_netthread_h
20 #include <tairon/core/thread.h>
22 namespace Tairon
25 namespace Net
28 class Loop;
30 }; // namespace Core
32 }; // namespace Tairon
34 namespace Tairent
37 namespace Core
40 /** \brief Thread for networking.
42 class NetThread : public Tairon::Core::Thread
44 public:
45 /** Constructs a thread object with name "net".
47 NetThread();
49 /** Destroys the thread.
51 ~NetThread();
53 /** Quits the loop.
55 void exit();
57 /** Executes the thread loop.
59 void *run();
61 private:
62 /** Whether the thread should exit.
64 bool e;
66 /** Network loop;
68 Tairon::Net::Loop *loop;
71 }; // namespace Core
73 }; // namespace Tairent
75 #endif
77 // vim: ai sw=4 ts=4 noet fdm=marker