\inmodule QtBluetooth More...

#include <qbluetoothserver.h>

Inheritance diagram for QBluetoothServer:

Collaboration diagram for QBluetoothServer:

Public Types
enum	Error { NoError , UnknownError , PoweredOffError , InputOutputError , ServiceAlreadyRegisteredError , UnsupportedProtocolError , MissingPermissionsError }
	This enum describes Bluetooth server error types. More...

Signals
void	newConnection ()
	This signal is emitted when a new connection is available.

void	errorOccurred (QBluetoothServer::Error error)
	This signal is emitted when an error occurs.

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QBluetoothServer (QBluetoothServiceInfo::Protocol serverType, QObject *parent=nullptr)
	Constructs a bluetooth server with parent and serverType.

	~QBluetoothServer ()
	Destroys the bluetooth server.

void	close ()
	Closes and resets the listening socket.

bool	listen (const QBluetoothAddress &address=QBluetoothAddress(), quint16 port=0)
	Start listening for incoming connections to address on port.

QBluetoothServiceInfo	listen (const QBluetoothUuid &uuid, const QString &serviceName=QString())
	Convenience function for registering an SPP service with uuid and serviceName.

bool	isListening () const
	Returns true if the server is listening for incoming connections, otherwise false.

void	setMaxPendingConnections (int numConnections)
	Sets the maximum number of pending connections to numConnections.

int	maxPendingConnections () const
	Returns the maximum number of pending connections.

bool	hasPendingConnections () const
	Returns true if a connection is pending, otherwise false.

QBluetoothSocket *	nextPendingConnection ()
	Returns a pointer to the QBluetoothSocket for the next pending connection.

QBluetoothAddress	serverAddress () const
	Returns the server address.

quint16	serverPort () const
	Returns the server port number.

void	setSecurityFlags (QBluetooth::SecurityFlags security)
	Sets the Bluetooth security flags to security.

QBluetooth::SecurityFlags	securityFlags () const
	Returns the Bluetooth security flags.

QBluetoothServiceInfo::Protocol	serverType () const
	Returns the type of the QBluetoothServer.

Error	error () const
	Returns the last error of the QBluetoothServer.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Protected Attributes
QBluetoothServerPrivate *	d_ptr

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\inmodule QtBluetooth

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

Since: 5.2

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 QBluetoothServiceInfo::registerService(). Call serverPort() to get the channel number that is being used.

If the \l QBluetoothServiceInfo::Protocol is not supported by a platform, \l 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

Definition at line 22 of file qbluetoothserver.h.

Member Enumeration Documentation

◆ Error

enum QBluetoothServer::Error

This enum describes Bluetooth server error types.

\value NoError No error. \value UnknownError An unknown error occurred. \value PoweredOffError The Bluetooth adapter is powered off. \value InputOutputError An input output error occurred. \value ServiceAlreadyRegisteredError The service or port was already registered \value UnsupportedProtocolError The \l {QBluetoothServiceInfo::Protocol}{Protocol} is not supported on this platform. \value [since 6.4] MissingPermissionsError The operating system requests permissions which were not granted by the user.

Enumerator
NoError
UnknownError
PoweredOffError
InputOutputError
ServiceAlreadyRegisteredError
UnsupportedProtocolError
MissingPermissionsError

Definition at line 27 of file qbluetoothserver.h.

Constructor & Destructor Documentation

◆ QBluetoothServer()

QBluetoothServer::QBluetoothServer	(	QBluetoothServiceInfo::Protocol	serverType,
		QObject *	parent = nullptr )

explicit

Constructs a bluetooth server with parent and serverType.

Definition at line 137 of file qbluetoothserver.cpp.

◆ ~QBluetoothServer()

QBluetoothServer::~QBluetoothServer ( )

Destroys the bluetooth server.

Definition at line 145 of file qbluetoothserver.cpp.

Member Function Documentation

◆ close()

void QBluetoothServer::close ( )

Closes and resets the listening socket.

Any already established \l QBluetoothSocket continues to operate and must be separately \l {QBluetoothSocket::close()}{closed}.

Definition at line 80 of file qbluetoothserver_android.cpp.

◆ error()

QBluetoothServer::Error QBluetoothServer::error ( ) const

Returns the last error of the QBluetoothServer.

Definition at line 288 of file qbluetoothserver.cpp.

◆ errorOccurred

void QBluetoothServer::errorOccurred ( QBluetoothServer::Error error )

signal

This signal is emitted when an error occurs.

See also: error(), QBluetoothServer::Error

Since: 6.2

◆ hasPendingConnections()

bool QBluetoothServer::hasPendingConnections ( ) const

Returns true if a connection is pending, otherwise false.

Definition at line 208 of file qbluetoothserver_android.cpp.

◆ isListening()

bool QBluetoothServer::isListening ( ) const

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

Definition at line 232 of file qbluetoothserver.cpp.

◆ listen() [1/2]

bool QBluetoothServer::listen	(	const QBluetoothAddress &	address = QBluetoothAddress(),
		quint16	port = 0 )

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. \l close() should be called before calling this function.

See also: isListening(), newConnection()

Definition at line 92 of file qbluetoothserver_android.cpp.

◆ listen() [2/2]

QBluetoothServiceInfo QBluetoothServer::listen	(	const QBluetoothUuid &	uuid,
		const QString &	serviceName = QString() )

nodiscard

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 \l QBluetoothServiceInfo::unregisterService() and \l 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 \l QBluetoothServiceInfo.

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

See also: isListening(), newConnection(), listen()

[listen]

[listen2]

[listen3]

Definition at line 174 of file qbluetoothserver.cpp.

◆ maxPendingConnections()

int QBluetoothServer::maxPendingConnections ( ) const

Returns the maximum number of pending connections.

See also: setMaxPendingConnections()

Definition at line 248 of file qbluetoothserver.cpp.

◆ newConnection

void QBluetoothServer::newConnection ( )

signal

This signal is emitted when a new connection is available.

The connected slot should call nextPendingConnection() to get a QBluetoothSocket object to send and receive data over the connection.

See also: nextPendingConnection(), hasPendingConnections()

◆ nextPendingConnection()

QBluetoothSocket * QBluetoothServer::nextPendingConnection ( )

Returns a pointer to the QBluetoothSocket for the next pending connection.

It is the callers responsibility to delete the pointer.

Definition at line 215 of file qbluetoothserver_android.cpp.

◆ securityFlags()

QBluetooth::SecurityFlags QBluetoothServer::securityFlags ( ) const

Returns the Bluetooth security flags.

Definition at line 240 of file qbluetoothserver_android.cpp.

◆ serverAddress()

QBluetoothAddress QBluetoothServer::serverAddress ( ) const

Returns the server address.

Definition at line 189 of file qbluetoothserver_android.cpp.

◆ serverPort()

quint16 QBluetoothServer::serverPort ( ) const

Returns the server port number.

Definition at line 201 of file qbluetoothserver_android.cpp.

◆ serverType()

QBluetoothServiceInfo::Protocol QBluetoothServer::serverType ( ) const

Returns the type of the QBluetoothServer.

Definition at line 278 of file qbluetoothserver.cpp.

◆ setMaxPendingConnections()

void QBluetoothServer::setMaxPendingConnections ( int numConnections )

Sets the maximum number of pending connections to numConnections.

If the number of pending sockets exceeds this limit new sockets will be rejected.

See also: maxPendingConnections()

Definition at line 182 of file qbluetoothserver_android.cpp.

◆ setSecurityFlags()

void QBluetoothServer::setSecurityFlags ( QBluetooth::SecurityFlags security )

Sets the Bluetooth security flags to security.

This function must be called before calling listen(). The Bluetooth link will always be encrypted when using Bluetooth 2.1 devices as encryption is mandatory.

Android only supports two levels of security (secure and non-secure). If this flag is set to \l QBluetooth::Security::NoSecurity the server object will not employ any authentication or encryption. Any other security flag combination will trigger a secure Bluetooth connection.

On \macos, security flags are not supported and will be ignored.

Definition at line 234 of file qbluetoothserver_android.cpp.

Member Data Documentation

◆ d_ptr

QBluetoothServerPrivate* QBluetoothServer::d_ptr

protected

Definition at line 69 of file qbluetoothserver.h.

The documentation for this class was generated from the following files:

qtconnectivity/src/bluetooth/qbluetoothserver.h (664d2a1cf019f76adf433d41b1418e515ffce86c)
qtconnectivity/src/bluetooth/qbluetoothserver.cpp (664d2a1cf019f76adf433d41b1418e515ffce86c)
qtconnectivity/src/bluetooth/qbluetoothserver_android.cpp (06d37147d1b59ca8cb5ce526a96b4ba59e44e0fa)
qtconnectivity/src/bluetooth/qbluetoothserver_bluez.cpp (664d2a1cf019f76adf433d41b1418e515ffce86c)
qtconnectivity/src/bluetooth/qbluetoothserver_macos.mm (ef996c8fd1d7d0db360f6f41e02a259561dbd9fe)
qtconnectivity/src/bluetooth/qbluetoothserver_p.cpp (664d2a1cf019f76adf433d41b1418e515ffce86c)
qtconnectivity/src/bluetooth/qbluetoothserver_winrt.cpp (664d2a1cf019f76adf433d41b1418e515ffce86c)

Public Types

Signals

Public Member Functions

Protected Attributes

Additional Inherited Members