<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>Class Poco::Net::SecureServerSocketImpl</title> <meta http-equiv="content-type" content="text/html; charset=utf-8"/> <meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="language" content="en"/> <meta name="date" content="2009-11-24"/> <meta name="generator" content="PocoDoc"/> <link rel="stylesheet" href="css/styles.css" type="text/css"/> </head> <body bgcolor="#ffffff" leftmargin="0" topmargin="0"> <div class="header"> <h1 class="namespace"><a href="Poco.Net.html" class="namespace">Poco::Net</a></h1> <h1 class="symbol">class SecureServerSocketImpl</h1> </div> <div class="body"> <p> <b>Library:</b> NetSSL_OpenSSL<br /> <b>Package:</b> SSLSockets<br /> <b>Header:</b> Poco/Net/SecureServerSocketImpl.h</p> <h2>Description</h2> <div class="description"> <p>The <a href="Poco.Net.SocketImpl.html" title="class Poco::Net::SocketImpl">SocketImpl</a> class for <a href="Poco.Net.SecureServerSocket.html" title="class Poco::Net::SecureServerSocket">SecureServerSocket</a>. </p> </div> <h2>Inheritance</h2> <p><b>Direct Base Classes: </b><a href="Poco.Net.ServerSocketImpl.html" title="class Poco::Net::ServerSocketImpl">ServerSocketImpl</a></p> <p><b>All Base Classes: </b><a href="Poco.Net.ServerSocketImpl.html" title="class Poco::Net::ServerSocketImpl">ServerSocketImpl</a>, <a href="Poco.Net.SocketImpl.html" title="class Poco::Net::SocketImpl">SocketImpl</a>, <a href="Poco.RefCountedObject.html" title="class Poco::RefCountedObject">Poco::RefCountedObject</a></p> <h2>Member Summary</h2> <p><b>Member Functions: </b><a href="Poco.Net.SecureServerSocketImpl.html#16042" title="Poco::Net::SecureServerSocketImpl::acceptConnection()">acceptConnection</a>, <a href="Poco.Net.SecureServerSocketImpl.html#16051" title="Poco::Net::SecureServerSocketImpl::bind()">bind</a>, <a href="Poco.Net.SecureServerSocketImpl.html#16056" title="Poco::Net::SecureServerSocketImpl::close()">close</a>, <a href="Poco.Net.SecureServerSocketImpl.html#16044" title="Poco::Net::SecureServerSocketImpl::connect()">connect</a>, <a href="Poco.Net.SecureServerSocketImpl.html#16049" title="Poco::Net::SecureServerSocketImpl::connectNB()">connectNB</a>, <a href="Poco.Net.SecureServerSocketImpl.html#16077" title="Poco::Net::SecureServerSocketImpl::context()">context</a>, <a href="Poco.Net.SecureServerSocketImpl.html#16054" title="Poco::Net::SecureServerSocketImpl::listen()">listen</a>, <a href="Poco.Net.SecureServerSocketImpl.html#16061" title="Poco::Net::SecureServerSocketImpl::receiveBytes()">receiveBytes</a>, <a href="Poco.Net.SecureServerSocketImpl.html#16070" title="Poco::Net::SecureServerSocketImpl::receiveFrom()">receiveFrom</a>, <a href="Poco.Net.SecureServerSocketImpl.html#16057" title="Poco::Net::SecureServerSocketImpl::sendBytes()">sendBytes</a>, <a href="Poco.Net.SecureServerSocketImpl.html#16065" title="Poco::Net::SecureServerSocketImpl::sendTo()">sendTo</a>, <a href="Poco.Net.SecureServerSocketImpl.html#16075" title="Poco::Net::SecureServerSocketImpl::sendUrgent()">sendUrgent</a></p> <p><b>Inherited Functions: </b><a href="Poco.Net.SocketImpl.html#15187" title="Poco::Net::SocketImpl::acceptConnection()">acceptConnection</a>, <a href="Poco.Net.SocketImpl.html#15241" title="Poco::Net::SocketImpl::address()">address</a>, <a href="Poco.Net.SocketImpl.html#15225" title="Poco::Net::SocketImpl::available()">available</a>, <a href="Poco.Net.SocketImpl.html#15196" title="Poco::Net::SocketImpl::bind()">bind</a>, <a href="Poco.Net.SocketImpl.html#15201" title="Poco::Net::SocketImpl::close()">close</a>, <a href="Poco.Net.SocketImpl.html#15189" title="Poco::Net::SocketImpl::connect()">connect</a>, <a href="Poco.Net.SocketImpl.html#15194" title="Poco::Net::SocketImpl::connectNB()">connectNB</a>, <a href="Poco.RefCountedObject.html#9659" title="Poco::RefCountedObject::duplicate()">duplicate</a>, <a href="Poco.Net.SocketImpl.html#15342" title="Poco::Net::SocketImpl::error()">error</a>, <a href="Poco.Net.SocketImpl.html#15319" title="Poco::Net::SocketImpl::getBlocking()">getBlocking</a>, <a href="Poco.Net.SocketImpl.html#15316" title="Poco::Net::SocketImpl::getBroadcast()">getBroadcast</a>, <a href="Poco.Net.SocketImpl.html#15304" title="Poco::Net::SocketImpl::getKeepAlive()">getKeepAlive</a>, <a href="Poco.Net.SocketImpl.html#15296" title="Poco::Net::SocketImpl::getLinger()">getLinger</a>, <a href="Poco.Net.SocketImpl.html#15301" title="Poco::Net::SocketImpl::getNoDelay()">getNoDelay</a>, <a href="Poco.Net.SocketImpl.html#15313" title="Poco::Net::SocketImpl::getOOBInline()">getOOBInline</a>, <a href="Poco.Net.SocketImpl.html#15268" title="Poco::Net::SocketImpl::getOption()">getOption</a>, <a href="Poco.Net.SocketImpl.html#15288" title="Poco::Net::SocketImpl::getRawOption()">getRawOption</a>, <a href="Poco.Net.SocketImpl.html#15234" title="Poco::Net::SocketImpl::getReceiveBufferSize()">getReceiveBufferSize</a>, <a href="Poco.Net.SocketImpl.html#15240" title="Poco::Net::SocketImpl::getReceiveTimeout()">getReceiveTimeout</a>, <a href="Poco.Net.SocketImpl.html#15307" title="Poco::Net::SocketImpl::getReuseAddress()">getReuseAddress</a>, <a href="Poco.Net.SocketImpl.html#15310" title="Poco::Net::SocketImpl::getReusePort()">getReusePort</a>, <a href="Poco.Net.SocketImpl.html#15231" title="Poco::Net::SocketImpl::getSendBufferSize()">getSendBufferSize</a>, <a href="Poco.Net.SocketImpl.html#15237" title="Poco::Net::SocketImpl::getSendTimeout()">getSendTimeout</a>, <a href="Poco.Net.SocketImpl.html#15333" title="Poco::Net::SocketImpl::init()">init</a>, <a href="Poco.Net.SocketImpl.html#15335" title="Poco::Net::SocketImpl::initSocket()">initSocket</a>, <a href="Poco.Net.SocketImpl.html#15328" title="Poco::Net::SocketImpl::initialized()">initialized</a>, <a href="Poco.Net.SocketImpl.html#15322" title="Poco::Net::SocketImpl::ioctl()">ioctl</a>, <a href="Poco.Net.SocketImpl.html#15341" title="Poco::Net::SocketImpl::lastError()">lastError</a>, <a href="Poco.Net.SocketImpl.html#15199" title="Poco::Net::SocketImpl::listen()">listen</a>, <a href="Poco.Net.SocketImpl.html#15242" title="Poco::Net::SocketImpl::peerAddress()">peerAddress</a>, <a href="Poco.Net.SocketImpl.html#15226" title="Poco::Net::SocketImpl::poll()">poll</a>, <a href="Poco.Net.SocketImpl.html#15209" title="Poco::Net::SocketImpl::receiveBytes()">receiveBytes</a>, <a href="Poco.Net.SocketImpl.html#15218" title="Poco::Net::SocketImpl::receiveFrom()">receiveFrom</a>, <a href="Poco.RefCountedObject.html#9661" title="Poco::RefCountedObject::referenceCount()">referenceCount</a>, <a href="Poco.RefCountedObject.html#9660" title="Poco::RefCountedObject::release()">release</a>, <a href="Poco.Net.SocketImpl.html#15339" title="Poco::Net::SocketImpl::reset()">reset</a>, <a href="Poco.Net.SocketImpl.html#15205" title="Poco::Net::SocketImpl::sendBytes()">sendBytes</a>, <a href="Poco.Net.SocketImpl.html#15213" title="Poco::Net::SocketImpl::sendTo()">sendTo</a>, <a href="Poco.Net.SocketImpl.html#15223" title="Poco::Net::SocketImpl::sendUrgent()">sendUrgent</a>, <a href="Poco.Net.SocketImpl.html#15317" title="Poco::Net::SocketImpl::setBlocking()">setBlocking</a>, <a href="Poco.Net.SocketImpl.html#15314" title="Poco::Net::SocketImpl::setBroadcast()">setBroadcast</a>, <a href="Poco.Net.SocketImpl.html#15302" title="Poco::Net::SocketImpl::setKeepAlive()">setKeepAlive</a>, <a href="Poco.Net.SocketImpl.html#15293" title="Poco::Net::SocketImpl::setLinger()">setLinger</a>, <a href="Poco.Net.SocketImpl.html#15299" title="Poco::Net::SocketImpl::setNoDelay()">setNoDelay</a>, <a href="Poco.Net.SocketImpl.html#15311" title="Poco::Net::SocketImpl::setOOBInline()">setOOBInline</a>, <a href="Poco.Net.SocketImpl.html#15243" title="Poco::Net::SocketImpl::setOption()">setOption</a>, <a href="Poco.Net.SocketImpl.html#15263" title="Poco::Net::SocketImpl::setRawOption()">setRawOption</a>, <a href="Poco.Net.SocketImpl.html#15232" title="Poco::Net::SocketImpl::setReceiveBufferSize()">setReceiveBufferSize</a>, <a href="Poco.Net.SocketImpl.html#15238" title="Poco::Net::SocketImpl::setReceiveTimeout()">setReceiveTimeout</a>, <a href="Poco.Net.SocketImpl.html#15305" title="Poco::Net::SocketImpl::setReuseAddress()">setReuseAddress</a>, <a href="Poco.Net.SocketImpl.html#15308" title="Poco::Net::SocketImpl::setReusePort()">setReusePort</a>, <a href="Poco.Net.SocketImpl.html#15229" title="Poco::Net::SocketImpl::setSendBufferSize()">setSendBufferSize</a>, <a href="Poco.Net.SocketImpl.html#15235" title="Poco::Net::SocketImpl::setSendTimeout()">setSendTimeout</a>, <a href="Poco.Net.SocketImpl.html#15204" title="Poco::Net::SocketImpl::shutdown()">shutdown</a>, <a href="Poco.Net.SocketImpl.html#15202" title="Poco::Net::SocketImpl::shutdownReceive()">shutdownReceive</a>, <a href="Poco.Net.SocketImpl.html#15203" title="Poco::Net::SocketImpl::shutdownSend()">shutdownSend</a>, <a href="Poco.Net.SocketImpl.html#15320" title="Poco::Net::SocketImpl::socketError()">socketError</a>, <a href="Poco.Net.SocketImpl.html#15321" title="Poco::Net::SocketImpl::sockfd()">sockfd</a></p> <h2>Constructors</h2> <h3><a name="16040">SecureServerSocketImpl</a></h3> <p class="decl"><a href="Poco.Net.SecureServerSocketImpl.html" title="class Poco::Net::SecureServerSocketImpl">SecureServerSocketImpl</a>(<br /> <a href="Poco.Net.Context.html#15711" title="Poco::Net::Context::Ptr">Context::Ptr</a> pContext<br />);</p> <div class="description"> <p>Creates the <a href="Poco.Net.SecureServerSocketImpl.html" title="class Poco::Net::SecureServerSocketImpl">SecureServerSocketImpl</a> using the given SSL context object. </p> </div> <h2>Destructor</h2> <h3><a name="16078">~SecureServerSocketImpl</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">~<a href="Poco.Net.SecureServerSocketImpl.html" title="class Poco::Net::SecureServerSocketImpl">SecureServerSocketImpl</a>();</p> <div class="description"> <p>Destroys the <a href="Poco.Net.SecureServerSocketImpl.html" title="class Poco::Net::SecureServerSocketImpl">SecureServerSocketImpl</a>. </p> </div> <h2>Member Functions</h2> <h3><a name="16042">acceptConnection</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.Net.SocketImpl.html" title="class Poco::Net::SocketImpl">SocketImpl</a> * acceptConnection(<br /> <a href="Poco.Net.SocketAddress.html" title="class Poco::Net::SocketAddress">SocketAddress</a> & clientAddr<br />);</p> <div class="description"> <p>Get the next completed connection from the socket's completed connection queue. </p> <p>If the queue is empty, waits until a connection request completes. </p> <p>Returns a new TCP socket for the connection with the client. </p> <p>The client socket's address is returned in clientAddr. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15187" title="Poco::Net::SocketImpl::acceptConnection()">Poco::Net::SocketImpl::acceptConnection()</a></p></div> <h3><a name="16051">bind</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void bind(<br /> const <a href="Poco.Net.SocketAddress.html" title="class Poco::Net::SocketAddress">SocketAddress</a> & address,<br /> bool reuseAddress = false<br />);</p> <div class="description"> <p>Bind a local address to the socket. </p> <p>This is usually only done when establishing a server socket. TCP clients should not bind a socket to a specific address. </p> <p>If reuseAddress is true, sets the SO_REUSEADDR socket option. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15196" title="Poco::Net::SocketImpl::bind()">Poco::Net::SocketImpl::bind()</a></p></div> <h3><a name="16056">close</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void close();</p> <div class="description"> <p>Close the socket. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15201" title="Poco::Net::SocketImpl::close()">Poco::Net::SocketImpl::close()</a></p></div> <h3><a name="16044">connect</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void connect(<br /> const <a href="Poco.Net.SocketAddress.html" title="class Poco::Net::SocketAddress">SocketAddress</a> & address<br />);</p> <div class="description"> <p>Not supported by this kind of socket. </p> <p>Throws a <a href="Poco.InvalidAccessException.html" title="class Poco::InvalidAccessException">Poco::InvalidAccessException</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15189" title="Poco::Net::SocketImpl::connect()">Poco::Net::SocketImpl::connect()</a></p></div> <h3><a name="16046">connect</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void connect(<br /> const <a href="Poco.Net.SocketAddress.html" title="class Poco::Net::SocketAddress">SocketAddress</a> & address,<br /> const <a href="Poco.Timespan.html" title="class Poco::Timespan">Poco::Timespan</a> & timeout<br />);</p> <div class="description"> <p>Not supported by this kind of socket. </p> <p>Throws a <a href="Poco.InvalidAccessException.html" title="class Poco::InvalidAccessException">Poco::InvalidAccessException</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15191" title="Poco::Net::SocketImpl::connect()">Poco::Net::SocketImpl::connect()</a></p></div> <h3><a name="16049">connectNB</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void connectNB(<br /> const <a href="Poco.Net.SocketAddress.html" title="class Poco::Net::SocketAddress">SocketAddress</a> & address<br />);</p> <div class="description"> <p>Not supported by this kind of socket. </p> <p>Throws a <a href="Poco.InvalidAccessException.html" title="class Poco::InvalidAccessException">Poco::InvalidAccessException</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15194" title="Poco::Net::SocketImpl::connectNB()">Poco::Net::SocketImpl::connectNB()</a></p></div> <h3><a name="16077">context</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.Net.Context.html#15711" title="Poco::Net::Context::Ptr">Context::Ptr</a> context() const;</p> <div class="description"> <p>Returns the SSL context used by this socket. </p> </div> <h3><a name="16054">listen</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void listen(<br /> int backlog = 64<br />);</p> <div class="description"> <p>Puts the socket into listening state. </p> <p>The socket becomes a passive socket that can accept incoming connection requests. </p> <p>The backlog argument specifies the maximum number of connections that can be queued for this socket. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15199" title="Poco::Net::SocketImpl::listen()">Poco::Net::SocketImpl::listen()</a></p></div> <h3><a name="16061">receiveBytes</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">int receiveBytes(<br /> void * buffer,<br /> int length,<br /> int flags = 0<br />);</p> <div class="description"> <p>Not supported by this kind of socket. </p> <p>Throws a <a href="Poco.InvalidAccessException.html" title="class Poco::InvalidAccessException">Poco::InvalidAccessException</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15209" title="Poco::Net::SocketImpl::receiveBytes()">Poco::Net::SocketImpl::receiveBytes()</a></p></div> <h3><a name="16070">receiveFrom</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">int receiveFrom(<br /> void * buffer,<br /> int length,<br /> <a href="Poco.Net.SocketAddress.html" title="class Poco::Net::SocketAddress">SocketAddress</a> & address,<br /> int flags = 0<br />);</p> <div class="description"> <p>Not supported by this kind of socket. </p> <p>Throws a <a href="Poco.InvalidAccessException.html" title="class Poco::InvalidAccessException">Poco::InvalidAccessException</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15218" title="Poco::Net::SocketImpl::receiveFrom()">Poco::Net::SocketImpl::receiveFrom()</a></p></div> <h3><a name="16057">sendBytes</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">int sendBytes(<br /> const void * buffer,<br /> int length,<br /> int flags = 0<br />);</p> <div class="description"> <p>Not supported by this kind of socket. </p> <p>Throws a <a href="Poco.InvalidAccessException.html" title="class Poco::InvalidAccessException">Poco::InvalidAccessException</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15205" title="Poco::Net::SocketImpl::sendBytes()">Poco::Net::SocketImpl::sendBytes()</a></p></div> <h3><a name="16065">sendTo</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">int sendTo(<br /> const void * buffer,<br /> int length,<br /> const <a href="Poco.Net.SocketAddress.html" title="class Poco::Net::SocketAddress">SocketAddress</a> & address,<br /> int flags = 0<br />);</p> <div class="description"> <p>Not supported by this kind of socket. </p> <p>Throws a <a href="Poco.InvalidAccessException.html" title="class Poco::InvalidAccessException">Poco::InvalidAccessException</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15213" title="Poco::Net::SocketImpl::sendTo()">Poco::Net::SocketImpl::sendTo()</a></p></div> <h3><a name="16075">sendUrgent</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void sendUrgent(<br /> unsigned char data<br />);</p> <div class="description"> <p>Not supported by this kind of socket. </p> <p>Throws a <a href="Poco.InvalidAccessException.html" title="class Poco::InvalidAccessException">Poco::InvalidAccessException</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Net.SocketImpl.html#15223" title="Poco::Net::SocketImpl::sendUrgent()">Poco::Net::SocketImpl::sendUrgent()</a></p></div> <p class="footer">POCO C++ Libraries 1.3.6-all<br /> Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p> </div> </body> </html>
