QTcpServer露
- PyQt5.QtNetwork.QTcpServer
Inherits from QObject.
Description露
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鈥檚 addresses.
Call listen() to have the server listen for incoming connections. The newConnection signal is then emitted each time a client connects to the server.
Call nextPendingConnection() to accept the pending connection as a connected QTcpSocket. The function returns a pointer to a QTcpSocket in ConnectedState that you can use for communicating with the client.
If an error occurs, serverError() returns the type of error, and errorString() can be called to get a human readable description of what happened.
When listening for connections, the address and port on which the server is listening are available as serverAddress() and serverPort().
Calling close() makes QTcpServer stop listening for incoming connections.
Although QTcpServer is mostly designed for use with an event loop, it鈥檚 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.
Methods露
- __init__(parent: QObject = None)
Constructs a QTcpServer object.
parent is passed to the QObject constructor.
See also
- addPendingConnection(QTcpSocket)
This function is called by incomingConnection() to add the socket to the list of pending incoming connections.
Note: Don鈥檛 forget to call this member from reimplemented incomingConnection() if you do not want to break the Pending Connections mechanism.
See also
- close()
Closes the server. The server will no longer listen for incoming connections.
See also
- errorString() → str
Returns a human readable description of the last error that occurred.
See also
- hasPendingConnections() → bool
Returns
trueif the server has a pending connection; otherwise returnsfalse.
- incomingConnection(sip.voidptr)
TODO
- isListening() → bool
Returns
trueif the server is currently listening for incoming connections; otherwise returnsfalse.See also
- listen(address: Union[QHostAddress, SpecialAddress] = Any, port: int = 0) → bool
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 Any, the server will listen on all network interfaces.
Returns
trueon success; otherwise returnsfalse.See also
- maxPendingConnections() → int
Returns the maximum number of pending accepted connections. The default is 30.
- nextPendingConnection() → QTcpSocket
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.
Note: The returned QTcpSocket object cannot be used from another thread. If you want to use an incoming connection from another thread, you need to override incomingConnection().
See also
- pauseAccepting()
Pauses accepting new connections. Queued connections will remain in queue.
See also
- proxy() → QNetworkProxy
Returns the network proxy for this socket. By default DefaultProxy is used.
See also
- resumeAccepting()
Resumes accepting new connections.
See also
- serverAddress() → QHostAddress
Returns the server鈥檚 address if the server is listening for connections; otherwise returns Null.
See also
- serverError() → SocketError
Returns an error code for the last error that occurred.
See also
- serverPort() → int
Returns the server鈥檚 port if the server is listening for connections; otherwise returns 0.
See also
- setMaxPendingConnections(int)
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.
See also
- setProxy(QNetworkProxy)
Sets the explicit network proxy for this socket to networkProxy.
To disable the use of a proxy for this socket, use the NoProxy proxy type:
# server->setProxy(QNetworkProxy::NoProxy);See also
- setSocketDescriptor(sip.voidptr) → bool
TODO
- socketDescriptor() → sip.voidptr
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.
See also
- waitForNewConnection(msecs: int = 0) → (bool, bool)
Waits for at most msec milliseconds or until an incoming connection is available. Returns
trueif a connection is available; otherwise returnsfalse. 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. 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.
See also
