PySide6.QtBluetooth.QBluetoothServer¶

class QBluetoothServer¶

The QBluetoothServer class uses the RFCOMM or L2cap protocol to communicate with a Bluetooth device. More…

Synopsis¶

Methods¶

def __init__()
def close()
def error()
def hasPendingConnections()
def isListening()
def listen()
def maxPendingConnections()
def nextPendingConnection()
def securityFlags()
def serverAddress()
def serverPort()
def serverType()
def setMaxPendingConnections()
def setSecurityFlags()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description¶

QBluetoothServer is used to implement Bluetooth services over RFCOMM or L2cap.

Start listening for incoming connections with listen() . Wait till the newConnection() signal is emitted when a new connection is established, and call nextPendingConnection() to get a QBluetoothSocket for the new connection.

To enable other devices to find your service, create a QBluetoothServiceInfo with the applicable attributes for your service and register it using registerService() . Call serverPort() to get the channel number that is being used.

If the Protocol is not supported by a platform, listen() will return false. Android and WinRT only support RFCOMM for example.

On iOS, this class cannot be used because the platform does not expose an API which may permit access to QBluetoothServer related features.

See also

QBluetoothServiceInfo QBluetoothSocket

class Error¶

This enum describes Bluetooth server error types.

Constant

Description

QBluetoothServer.NoError

No error.

QBluetoothServer.UnknownError

An unknown error occurred.

QBluetoothServer.PoweredOffError

The Bluetooth adapter is powered off.

QBluetoothServer.InputOutputError

An input output error occurred.

QBluetoothServer.ServiceAlreadyRegisteredError

The service or port was already registered

QBluetoothServer.UnsupportedProtocolError

The Protocol is not supported on this platform.

QBluetoothServer.MissingPermissionsError

The operating system requests permissions which were not granted by the user.

Constant	Description
QBluetoothServer.NoError	No error.
QBluetoothServer.UnknownError	An unknown error occurred.
QBluetoothServer.PoweredOffError	The Bluetooth adapter is powered off.
QBluetoothServer.InputOutputError	An input output error occurred.
QBluetoothServer.ServiceAlreadyRegisteredError	The service or port was already registered
QBluetoothServer.UnsupportedProtocolError	The `Protocol` is not supported on this platform.
QBluetoothServer.MissingPermissionsError	The operating system requests permissions which were not granted by the user.

__init__(serverType[, parent=None])¶

Parameters:

serverType – Protocol
parent – QObject

Constructs a bluetooth server with parent and serverType.

close()¶

Closes and resets the listening socket. Any already established QBluetoothSocket continues to operate and must be separately closed .

error()¶

Return type:: Error

Returns the last error of the QBluetoothServer .

errorOccurred(error)¶

Parameters:: error – Error

This signal is emitted when an error occurs.

See also

error() Error

hasPendingConnections()¶

Return type:: bool

Returns true if a connection is pending, otherwise false.

isListening()¶

Return type:: bool

Returns true if the server is listening for incoming connections, otherwise false.

listen([address=QBluetoothAddress()[, port=0]])¶

Parameters:

address – QBluetoothAddress
port – int

Return type:

bool

Start listening for incoming connections to address on port. address must be a local Bluetooth adapter address and port must be larger than zero and not be taken already by another Bluetooth server object. It is recommended to avoid setting a port number to enable the system to automatically choose a port.

Returns true if the operation succeeded and the server is listening for incoming connections, otherwise returns false.

If the server object is already listening for incoming connections this function always returns false. close() should be called before calling this function.

See also

isListening() newConnection()

listen(uuid[, serviceName=""])

Parameters:

uuid – QBluetoothUuid
serviceName – str

Return type:

QBluetoothServiceInfo

Warning

This section contains snippets that were automatically translated from C++ to Python and may contain errors.

Convenience function for registering an SPP service with uuid and serviceName. Because this function already registers the service, the QBluetoothServiceInfo object which is returned can not be changed any more. To shutdown the server later on it is required to call unregisterService() and close() on this server object.

Returns a registered QBluetoothServiceInfo instance if successful otherwise an invalid QBluetoothServiceInfo . This function always assumes that the default Bluetooth adapter should be used.

If the server object is already listening for incoming connections this function returns an invalid QBluetoothServiceInfo .

For an RFCOMM server this function is equivalent to following code snippet.

<Code snippet "qbluetoothserver.cpp:listen" not found>
<Code snippet "qbluetoothserver.cpp:listen2" not found>
<Code snippet "qbluetoothserver.cpp:listen3" not found>