POCO C++ Libraries提供一套 C++ 的類(lèi)庫(kù)用以開(kāi)發(fā)基于網(wǎng)絡(luò)的可移植的應(yīng)用程序，功能涉及線(xiàn)程、文件、流，網(wǎng)絡(luò)協(xié)議包括：HTTP、FTP、SMTP 等，還提供 XML 的解析和 SQL 數(shù)據(jù)庫(kù)的訪(fǎng)問(wèn)接口。不僅給我的工作帶來(lái)極大的便利，而且設(shè)計(jì)巧妙，代碼易讀，注釋豐富，也是非常好的學(xué)習(xí)材料，我個(gè)人非常喜歡。POCO的創(chuàng)始人在這個(gè)開(kāi)源項(xiàng)目的基礎(chǔ)上做了一些收費(fèi)產(chǎn)品，也成立了自己的公司，"I am in the lucky position to work for my own company"，真是讓人羨慕啊。
POCO C++ Libraries
基于POCO的產(chǎn)品
Poco主頁(yè)：
http://pocoproject.org/Poco文檔：
http://pocoproject.org/docs/創(chuàng)始人主頁(yè)：
http://obiltschnig.com/公司主頁(yè)：
http://www.appinf.com/我主要用過(guò)Net，Data，XML部分，Net里對(duì)socket的封裝類(lèi)，實(shí)現(xiàn)TCP，HTTP，SMTP協(xié)議的框架，Data里對(duì)MySQL接口封裝，XML里對(duì)DOM標(biāo)準(zhǔn)的實(shí)現(xiàn)。我目前主要是做C++網(wǎng)絡(luò)編程，曾經(jīng)嘗試接觸ACE庫(kù)，但覺(jué)得太復(fù)雜難理解，而且也沒(méi)有條件用于項(xiàng)目，后來(lái)發(fā)現(xiàn)了Poco，不僅簡(jiǎn)單易用，而且也包含《C++ Networking Programming》中提到的各種模式和框架，更難得的是文檔注釋豐富，看起源碼來(lái)相當(dāng)舒服。因此想寫(xiě)一些筆記，一方面借此加深對(duì)網(wǎng)絡(luò)編程的理解，另一方面也希望和大家多多交流。
第一篇討論P(yáng)oco::TCPServer框架，先看看Poco::TCPServer有哪些類(lèi)
class Net_API TCPServer: public Poco::Runnable
class Net_API TCPServerConnection: public Poco::Runnable
class Net_API TCPServerConnectionFactory
class Net_API TCPServerDispatcher: public Poco::Runnable
class Net_API TCPServerParams: public Poco::RefCountedObjectRunnable是一個(gè)抽象類(lèi)，要求其子類(lèi)實(shí)現(xiàn)一個(gè)run()函數(shù)，run()一般作為線(xiàn)程的入口函數(shù).
先看看run函數(shù)是如何被調(diào)用的，以TCPServer為例。
void TCPServer::start()
{
poco_assert (_stopped);
_stopped = false;
_thread.start(*this);//這里傳入本類(lèi)對(duì)象地址
}
再看看Thread類(lèi)的start函數(shù)
class Foundation_API Thread: private ThreadImpl
void Thread::start(Runnable& target)
{
startImpl(target);
}
這里的ThreadImpl::startImpl是POSIX實(shí)現(xiàn)版本
void ThreadImpl::startImpl(Runnable& target)
{
_pData->pRunnableTarget = ⌖
if (pthread_create(&_pData->thread, &attributes, runnableEntry, this))
{
_pData->pRunnableTarget = 0;
throw SystemException("cannot start thread");
}
pRunnableTarget就指向Runnable了
void* ThreadImpl::runnableEntry(void* pThread)
{
ThreadImpl* pThreadImpl = reinterpret_cast<ThreadImpl*>(pThread);
AutoPtr<ThreadData> pData = pThreadImpl->_pData;
try
{
pData->pRunnableTarget->run();//在這里
}
catch (Exception& exc)
知道run()是如何被調(diào)用了，再看看TcpServer::run()的實(shí)現(xiàn)
1void TCPServer::run()
2{
3 while (!_stopped)
4 {
5 Poco::Timespan timeout(250000);
6 if (_socket.poll(timeout, Socket::SELECT_READ))
7 {
8 try
9 {
10 StreamSocket ss = _socket.acceptConnection();
11 // enabe nodelay per default: OSX really needs that
12 ss.setNoDelay(true);
13 _pDispatcher->enqueue(ss);
14 }
15 catch (Poco::Exception& exc)
16
在第6行調(diào)用標(biāo)準(zhǔn)select函數(shù)，準(zhǔn)備好讀后，第10行調(diào)用標(biāo)準(zhǔn)accept建立連接，然后把StreamSocke對(duì)象放入TCPServerDispatcher對(duì)象內(nèi)的隊(duì)列中，可見(jiàn)TCPServer只是建立連接，之后的工作就都交給TCPServerDispatcher了。
在講TCPServerDispatcher之前，先需要說(shuō)明的是第10行TCPServer的_socket成員變量類(lèi)型是ServerSocket，ServerSocket在一個(gè)構(gòu)造函數(shù)中調(diào)用了bind和listen，具體如下
ServerSocket::ServerSocket(Poco::UInt16 port, int backlog): Socket(new ServerSocketImpl)
{
IPAddress wildcardAddr;
SocketAddress address(wildcardAddr, port);
impl()->bind(address, true);
impl()->listen(backlog);
}
要注意，盡管ServerSocket類(lèi)提供了無(wú)參構(gòu)造函數(shù)，但使用無(wú)參構(gòu)造函數(shù)創(chuàng)建的對(duì)象，在TCPServer對(duì)象調(diào)用start()之前，必須先bind和listen。
" /// Before start() is called, the ServerSocket passed to
/// TCPServer must have been bound and put into listening state."
繼續(xù)看TCPServerDispatcher，沿著TcpServer::run()第13行，我們看它的equeue()
1void TCPServerDispatcher::enqueue(const StreamSocket& socket)
2{
3 FastMutex::ScopedLock lock(_mutex);
4
5 if (_queue.size() < _pParams->getMaxQueued())
6 {
7 _queue.enqueueNotification(new TCPConnectionNotification(socket));
8 if (!_queue.hasIdleThreads() && _currentThreads < _pParams->getMaxThreads())
9 {
10 try
11 {
12 static const std::string threadName("TCPServerConnection");
13 _threadPool.start(*this, threadName);
14 ++_currentThreads;
15 }
16 catch (Poco::Exception&)
17
第7行enqueueNotification把一個(gè)TCPConnectionNotification入隊(duì)，第13行把this交給ThreadPool啟動(dòng)一個(gè)線(xiàn)程，那么這個(gè)線(xiàn)程就要運(yùn)行TCPServerDispatcher的run函數(shù)了，看TCPServerDispatcher::run()
1void TCPServerDispatcher::run()
2{
3 AutoPtr<TCPServerDispatcher> guard(this, true); // ensure object stays alive
4
5 int idleTime = (int) _pParams->getThreadIdleTime().totalMilliseconds();
6
7 for (;;)
8 {
9 AutoPtr<Notification> pNf = _queue.waitDequeueNotification(idleTime);
10 if (pNf)
11 {
12 TCPConnectionNotification* pCNf = dynamic_cast<TCPConnectionNotification*>(pNf.get());
13 if (pCNf)
14 {
15 std::auto_ptr<TCPServerConnection> pConnection(_pConnectionFactory->createConnection(pCNf->socket()));
16 poco_check_ptr(pConnection.get());
17 beginConnection();
18 pConnection->start();
19 endConnection();
20 }
21 }
第9行waitDequeueNotification一個(gè)Notification，第12行把這個(gè)通知類(lèi)型轉(zhuǎn)換成TCPConnectionNotification，聯(lián)系之前的enqueueNotification，大概能才到是什么意思。第15行又出現(xiàn)個(gè)TCPServerConnection。好吧，看來(lái)搞清楚TCPServerDispatcher還是要先看下TCPServerConnection，還有TCPConnectionNotification。
盡管TCPServerConnection繼承了Runable，但沒(méi)有實(shí)現(xiàn)run()，它的start()如下
void TCPServerConnection::start()
{
try
{
run();
}
用戶(hù)需要繼承TCPServerConnection實(shí)現(xiàn)run函數(shù)，看下源碼中的說(shuō)明，要完成對(duì)這個(gè)socket的處理，因?yàn)閞un函數(shù)返回時(shí)，連接就自動(dòng)關(guān)閉了。
class Net_API TCPServerConnection: public Poco::Runnable
/**//// The abstract base class for TCP server connections
/// created by TCPServer.
///
/// Derived classes must override the run() method
/// (inherited from Runnable). Furthermore, a
/// TCPServerConnectionFactory must be provided for the subclass.
///
/// The run() method must perform the complete handling
/// of the client connection. As soon as the run() method
/// returns, the server connection object is destroyed and
/// the connection is automatically closed.
///
/// A new TCPServerConnection object will be created for
/// each new client connection that is accepted by
/// TCPServer.
連接在哪被關(guān)閉的呢，注釋說(shuō)隨著TCPServerConnection對(duì)象銷(xiāo)毀而關(guān)閉。具體就是，TCPServerConnection類(lèi)有個(gè)StreamSocket成員，StreamSocket繼承自Socket，Socket類(lèi)又包含了個(gè)SocketImpl成員，所以就有~TCPServerConnection()->~StreamSocket()->~Socket()->~SocketImpl()，最后~SocketImpl()調(diào)用close()關(guān)閉了連接。
那么TCPServerConnection對(duì)象何時(shí)被創(chuàng)建何時(shí)被銷(xiāo)毀呢，這下又回到TCPServerDispatcher::run()來(lái)了，看TCPServerDispatcher::run()的第15行，創(chuàng)建了TCPServerConnection對(duì)象，第18行調(diào)用TCPServerConnection::start()進(jìn)而調(diào)用TCPServerConnection::run()，第20行塊結(jié)束，TCPServerConnection對(duì)象隨著智能指針?shù)N毀而被銷(xiāo)毀。
還剩TCPConnectionNotification或者說(shuō)Notification要搞清楚了，但是要對(duì)Poco的Notifactions模塊源碼進(jìn)行分析的話(huà)，本文的篇幅也就太長(zhǎng)了，就從文檔來(lái)大致看看吧
Notifications
Facilities for type-safe sending and delivery of notification objects within a single thread or from one thread to another, also well suited for the implementation of notification mechanisms. A notification queue class for distributing tasks to worker threads, simplifying the implementation of multithreaded servers.
簡(jiǎn)單的說(shuō)Notifications模塊可用于線(xiàn)程間傳遞消息，簡(jiǎn)化多線(xiàn)程服務(wù)器的實(shí)現(xiàn)。具體到TCPServer，就是把已連接的socket，放到NotificationQueue中，并從TheadPool出來(lái)一個(gè)線(xiàn)程，線(xiàn)程從NotificationQueue取到這個(gè)socket，從而用TCPServerConnection::run()里的邏輯對(duì)socket進(jìn)行處理。
至此TCPServer基本分析完畢，還有TCPServerConnectionFactory和TCPServerParams，分別用于產(chǎn)生TCPServerConnection和設(shè)置參數(shù)，就不細(xì)說(shuō)了。
縱觀Poco::TCPServer，套一下
《Unix Network Programming》里講的服務(wù)器模型，屬于“在程序啟動(dòng)階段創(chuàng)建一個(gè)線(xiàn)程池之后讓主線(xiàn)程調(diào)用accept，并把每個(gè)客戶(hù)連接傳遞給池中某個(gè)可用線(xiàn)程”。Poco1.3.6版里用select作為IO multiplexing。1.3.7版正在嘗試epoll(windows平臺(tái)依然是select)，但還未release，跟蹤svn來(lái)看也沒(méi)有使用edge-triggered模式。套用《The C10K problem》里講的服務(wù)器模型，屬于"Serve many clients with each thread, and use nonblocking I/O and level-triggered readiness notification"。總結(jié)起來(lái)就是：non-blocking IO + IO multiplexing(level-triggered) + thread pool。
Poco::TCPServer也許并不能算一個(gè)性能很高的TCP服務(wù)器，但我非常喜歡它的設(shè)計(jì)和編碼風(fēng)格。順便提一下對(duì)底層socket的封裝，由socket類(lèi)派生的各種子類(lèi)，ServerSocket在構(gòu)造函數(shù)中進(jìn)行bind和listen，StreamSocket在構(gòu)造函數(shù)進(jìn)行connect，都是非常貼心的設(shè)計(jì)。
下一篇打算分析Poco的Reator框架。