The QTcpServer class provides a TCP-based server. More...
Note: All functions in this class are reentrant.
|QTcpServer ( QObject * parent = 0 )|
|QString||errorString () const|
|virtual bool||hasPendingConnections () const|
|bool||isListening () const|
|bool||listen ( const QHostAddress & address = QHostAddress::Any, quint16 port = 0 )|
|int||maxPendingConnections () const|
|virtual QTcpSocket *||nextPendingConnection ()|
|QNetworkProxy||proxy () const|
|QHostAddress||serverAddress () const|
|QAbstractSocket::SocketError||serverError () const|
|quint16||serverPort () const|
|void||setMaxPendingConnections ( int numConnections )|
|void||setProxy ( const QNetworkProxy & networkProxy )|
|bool||setSocketDescriptor ( int socketDescriptor )|
|int||socketDescriptor () const|
|bool||waitForNewConnection ( int msec = 0, bool * timedOut = 0 )|
- 29 public functions inherited from QObject
- 1 signal inherited from QObject
|void||addPendingConnection ( QTcpSocket * socket )|
|virtual void||incomingConnection ( int socketDescriptor )|
- 8 protected functions inherited from QObject
Additional Inherited Members
- 1 property inherited from QObject
- 1 public slot inherited from QObject
- 7 static public members inherited from QObject
The QTcpServer class provides a TCP-based server.
This class makes it possible to accept incoming TCP connections. You can specify the port or have QTcpServer pick one automatically. You can listen on a specific address or on all the machine's addresses.
Call nextPendingConnection() to accept the pending connection as a connected QTcpSocket. The function returns a pointer to a QTcpSocket in QAbstractSocket::ConnectedState that you can use for communicating with the client.
Calling close() makes QTcpServer stop listening for incoming connections.
Although QTcpServer is mostly designed for use with an event loop, it's possible to use it without one. In that case, you must use waitForNewConnection(), which blocks until either a connection is available or a timeout expires.
Symbian Platform Security Requirements
On Symbian, processes which use this class must have the NetworkServices platform security capability. If the client process lacks this capability, it will lead to a panic.
Platform security capabilities are added via the TARGET.CAPABILITY qmake variable.
See also QTcpSocket, Fortune Server Example, Threaded Fortune Server Example, Loopback Example, and Torrent Example.
Member Function Documentation
QTcpServer::QTcpServer ( QObject * parent = 0 )
Constructs a QTcpServer object.
parent is passed to the QObject constructor.
Destroys the QTcpServer object. If the server is listening for connections, the socket is automatically closed.
Any client QTcpSockets that are still connected must either disconnect or be reparented before the server is deleted.
See also close().
void QTcpServer::addPendingConnection ( QTcpSocket * socket ) [protected]
This function is called by QTcpServer::incomingConnection() to add the socket to the list of pending incoming connections.
Note: Don't forget to call this member from reimplemented incomingConnection() if you do not want to break the Pending Connections mechanism.
This function was introduced in Qt 4.7.
See also incomingConnection().
Closes the server. The server will no longer listen for incoming connections.
See also listen().
QString QTcpServer::errorString () const
Returns a human readable description of the last error that occurred.
See also serverError().
Returns true if the server has a pending connection; otherwise returns false.
This virtual function is called by QTcpServer when a new connection is available. The socketDescriptor argument is the native socket descriptor for the accepted connection.
Reimplement this function to alter the server's behavior when a connection is available.
Note: If you want to handle an incoming connection as a new QTcpSocket object in another thread you have to pass the socketDescriptor to the other thread and create the QTcpSocket object there and use its setSocketDescriptor() method.
Returns true if the server is currently listening for incoming connections; otherwise returns false.
See also listen().
bool QTcpServer::listen ( const QHostAddress & address = QHostAddress::Any, quint16 port = 0 )
Tells the server to listen for incoming connections on address address and port port. If port is 0, a port is chosen automatically. If address is QHostAddress::Any, the server will listen on all network interfaces.
Returns true on success; otherwise returns false.
See also isListening().
Returns the maximum number of pending accepted connections. The default is 30.
This signal is emitted every time a new connection is available.
QTcpSocket * QTcpServer::nextPendingConnection () [virtual]
Returns the next pending connection as a connected QTcpSocket object.
The socket is created as a child of the server, which means that it is automatically deleted when the QTcpServer object is destroyed. It is still a good idea to delete the object explicitly when you are done with it, to avoid wasting memory.
0 is returned if this function is called when there are no pending connections.
See also hasPendingConnections().
QNetworkProxy QTcpServer::proxy () const
Returns the network proxy for this socket. By default QNetworkProxy::DefaultProxy is used.
This function was introduced in Qt 4.1.
QHostAddress QTcpServer::serverAddress () const
Returns the server's address if the server is listening for connections; otherwise returns QHostAddress::Null.
QAbstractSocket::SocketError QTcpServer::serverError () const
Returns an error code for the last error that occurred.
See also errorString().
quint16 QTcpServer::serverPort () const
Returns the server's port if the server is listening for connections; otherwise returns 0.
Sets the maximum number of pending accepted connections to numConnections. QTcpServer will accept no more than numConnections incoming connections before nextPendingConnection() is called. By default, the limit is 30 pending connections.
Clients may still able to connect after the server has reached its maximum number of pending connections (i.e., QTcpSocket can still emit the connected() signal). QTcpServer will stop accepting the new connections, but the operating system may still keep them in queue.
void QTcpServer::setProxy ( const QNetworkProxy & networkProxy )
Sets the explicit network proxy for this socket to networkProxy.
To disable the use of a proxy for this socket, use the QNetworkProxy::NoProxy proxy type:
This function was introduced in Qt 4.1.
Sets the socket descriptor this server should use when listening for incoming connections to socketDescriptor. Returns true if the socket is set successfully; otherwise returns false.
The socket is assumed to be in listening state.
Returns the native socket descriptor the server uses to listen for incoming instructions, or -1 if the server is not listening.
If the server is using QNetworkProxy, the returned descriptor may not be usable with native socket functions.
Waits for at most msec milliseconds or until an incoming connection is available. Returns true if a connection is available; otherwise returns false. If the operation timed out and timedOut is not 0, *timedOut will be set to true.
This is a blocking function call. Its use is disadvised in a single-threaded GUI application, since the whole application will stop responding until the function returns. waitForNewConnection() is mostly useful when there is no event loop available.
The non-blocking alternative is to connect to the newConnection() signal.
If msec is -1, this function will not time out.
© 2012 Nokia Corporation and/or its subsidiaries. Documentation contributions included herein are the copyrights of their respective owners.
The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.
Documentation sources may be obtained from www.qt-project.org.