1 | // |
---|
2 | // TCPServerConnection.h |
---|
3 | // |
---|
4 | // $Id: //poco/1.3/Net/include/Poco/Net/TCPServerConnection.h#1 $ |
---|
5 | // |
---|
6 | // Library: Net |
---|
7 | // Package: TCPServer |
---|
8 | // Module: TCPServerConnection |
---|
9 | // |
---|
10 | // Definition of the TCPServerConnection class. |
---|
11 | // |
---|
12 | // Copyright (c) 2005-2006, Applied Informatics Software Engineering GmbH. |
---|
13 | // and Contributors. |
---|
14 | // |
---|
15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
20 | // do so, all subject to the following: |
---|
21 | // |
---|
22 | // The copyright notices in the Software and this entire statement, including |
---|
23 | // the above license grant, this restriction and the following disclaimer, |
---|
24 | // must be included in all copies of the Software, in whole or in part, and |
---|
25 | // all derivative works of the Software, unless such copies or derivative |
---|
26 | // works are solely in the form of machine-executable object code generated by |
---|
27 | // a source language processor. |
---|
28 | // |
---|
29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
35 | // DEALINGS IN THE SOFTWARE. |
---|
36 | // |
---|
37 | |
---|
38 | |
---|
39 | #ifndef Net_TCPServerConnection_INCLUDED |
---|
40 | #define Net_TCPServerConnection_INCLUDED |
---|
41 | |
---|
42 | |
---|
43 | #include "Poco/Net/Net.h" |
---|
44 | #include "Poco/Net/StreamSocket.h" |
---|
45 | #include "Poco/Runnable.h" |
---|
46 | |
---|
47 | |
---|
48 | namespace Poco { |
---|
49 | namespace Net { |
---|
50 | |
---|
51 | |
---|
52 | class Net_API TCPServerConnection: public Poco::Runnable |
---|
53 | /// The abstract base class for TCP server connections |
---|
54 | /// created by TCPServer. |
---|
55 | /// |
---|
56 | /// Derived classes must override the run() method |
---|
57 | /// (inherited from Runnable). Furthermore, a |
---|
58 | /// TCPServerConnectionFactory must be provided for the subclass. |
---|
59 | /// |
---|
60 | /// The run() method must perform the complete handling |
---|
61 | /// of the client connection. As soon as the run() method |
---|
62 | /// returns, the server connection object is destroyed and |
---|
63 | /// the connection is automatically closed. |
---|
64 | /// |
---|
65 | /// A new TCPServerConnection object will be created for |
---|
66 | /// each new client connection that is accepted by |
---|
67 | /// TCPServer. |
---|
68 | { |
---|
69 | public: |
---|
70 | TCPServerConnection(const StreamSocket& socket); |
---|
71 | /// Creates the TCPServerConnection using the given |
---|
72 | /// stream socket. |
---|
73 | |
---|
74 | virtual ~TCPServerConnection(); |
---|
75 | /// Destroys the TCPServerConnection. |
---|
76 | |
---|
77 | protected: |
---|
78 | StreamSocket& socket(); |
---|
79 | /// Returns a reference to the underlying socket. |
---|
80 | |
---|
81 | void start(); |
---|
82 | /// Calls run() and catches any exceptions that |
---|
83 | /// might be thrown by run(). |
---|
84 | |
---|
85 | private: |
---|
86 | TCPServerConnection(); |
---|
87 | TCPServerConnection(const TCPServerConnection&); |
---|
88 | TCPServerConnection& operator = (const TCPServerConnection&); |
---|
89 | |
---|
90 | StreamSocket _socket; |
---|
91 | |
---|
92 | friend class TCPServerDispatcher; |
---|
93 | }; |
---|
94 | |
---|
95 | |
---|
96 | // |
---|
97 | // inlines |
---|
98 | // |
---|
99 | inline StreamSocket& TCPServerConnection::socket() |
---|
100 | { |
---|
101 | return _socket; |
---|
102 | } |
---|
103 | |
---|
104 | |
---|
105 | } } // namespace Poco::Net |
---|
106 | |
---|
107 | |
---|
108 | #endif // Net_TCPServerConnection_INCLUDED |
---|