BluezQt::ObexManager

BluezQt
ObexManager

#include <BluezQt/ObexManager>

Inheritance diagram for BluezQt::ObexManager:

Properties
bool	initialized

bool	operational

QList< ObexSessionPtr >	sessions

Properties inherited from QObject
	objectName

Signals
void	operationalChanged (bool operational)

void	sessionAdded (ObexSessionPtr session)

void	sessionRemoved (ObexSessionPtr session)

Public Slots
PendingCall *	createSession (const QString &destination, const QVariantMap &args)

PendingCall *	registerAgent (ObexAgent *agent)

PendingCall *	removeSession (const QDBusObjectPath &session)

PendingCall *	unregisterAgent (ObexAgent *agent)

Public Member Functions
	ObexManager (QObject *parent=nullptr)

	~ObexManager () override

InitObexManagerJob *	init ()

bool	isInitialized () const

bool	isOperational () const

ObexSessionPtr	sessionForPath (const QDBusObjectPath &path) const

QList< ObexSessionPtr >	sessions () const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

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

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

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

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

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Static Public Member Functions
static PendingCall *	startService ()

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

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

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

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

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Additional Inherited Members
Public Attributes inherited from QObject
typedef	QObjectList

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Detailed Description

OBEX manager.

The entry point to communicate with session BlueZ obex daemon.

You must call init() before other functions can be used.

Note: If manager is not operational, all methods that returns a PendingCall will fail with PendingCall::InternalError.

Definition at line 39 of file obexmanager.h.

Property Documentation

◆ initialized

bool BluezQt::ObexManager::initialized

read

Definition at line 43 of file obexmanager.h.

◆ operational

bool BluezQt::ObexManager::operational

read

Definition at line 44 of file obexmanager.h.

◆ sessions

QList<ObexSessionPtr> BluezQt::ObexManager::sessions

read

Definition at line 45 of file obexmanager.h.

Constructor & Destructor Documentation

◆ ObexManager()

BluezQt::ObexManager::ObexManager ( QObject * parent = nullptr )

explicit

Creates a new ObexManager object.

Parameters

parent

Definition at line 23 of file obexmanager.cpp.

◆ ~ObexManager()

BluezQt::ObexManager::~ObexManager ( )

overridedefault

Destroys an ObexManager object.

Member Function Documentation

◆ createSession

PendingCall * BluezQt::ObexManager::createSession	(	const QString &	destination,
		const QVariantMap &	args )

slot

Creates a new OBEX session.

The args parameter is a dictionary to hold optional or type-specific parameters.

Typical parameters:

QString target - type of session to be created
QString source - device address to be used

Supported targets:

ftp - ObexFileTransfer
map
opp - ObexObjectPush
pbap
sync

Possible errors: PendingCall::InvalidArguments, PendingCall::Failed

Parameters

destination	address of target device
args	session parameters

Returns: QDBusObjectPath pending call

Definition at line 105 of file obexmanager.cpp.

◆ init()

InitObexManagerJob * BluezQt::ObexManager::init ( )

Creates a new init job.

Returns: init manager job

Definition at line 32 of file obexmanager.cpp.

◆ isInitialized()

bool BluezQt::ObexManager::isInitialized ( ) const

Returns whether the manager is initialized.

Returns: true if manager is initialized

Definition at line 37 of file obexmanager.cpp.

◆ isOperational()

bool BluezQt::ObexManager::isOperational ( ) const

Returns whether the manager is operational.

The manager is operational when initialization was successful and BlueZ session daemon is running.

Returns: true if manager is operational

Definition at line 42 of file obexmanager.cpp.

◆ operationalChanged

void BluezQt::ObexManager::operationalChanged ( bool operational )

signal

Indicates that operational state have changed.

◆ registerAgent

PendingCall * BluezQt::ObexManager::registerAgent ( ObexAgent * agent )

slot

Registers agent.

This agent will be used to authorize an incoming object push requests.

Possible errors: PendingCall::AlreadyExists

Parameters

agent agent to be registered

Returns: void pending call

Definition at line 75 of file obexmanager.cpp.

◆ removeSession

PendingCall * BluezQt::ObexManager::removeSession ( const QDBusObjectPath & session )

slot

Removes an existing OBEX session.

Possible errors: PendingCall::InvalidArguments, PendingCall::NotAuthorized

Parameters

session session to be removed

Returns: void pending call

Definition at line 114 of file obexmanager.cpp.

◆ sessionAdded

void BluezQt::ObexManager::sessionAdded ( ObexSessionPtr session )

signal

Indicates that the session was added.

◆ sessionForPath()

ObexSessionPtr BluezQt::ObexManager::sessionForPath ( const QDBusObjectPath & path ) const

Returns a session for specified path.

The path does not need to be equal to ObexSession path, startsWith test is performed in the search. That means you can use this method to get ObexSession from path returned by createSession().

Parameters

path	path of session

Returns: null if there is no session with specified path

Definition at line 52 of file obexmanager.cpp.

◆ sessionRemoved

void BluezQt::ObexManager::sessionRemoved ( ObexSessionPtr session )

signal

Indicates that the session was removed.

◆ sessions()

QList< ObexSessionPtr > BluezQt::ObexManager::sessions ( ) const

Returns a list of all sessions.

Returns: list of sessions

Definition at line 47 of file obexmanager.cpp.

◆ startService()

PendingCall * BluezQt::ObexManager::startService ( )

static

Attempts to start org.bluez.obex service by D-Bus activation.

Possible return values are 1 if the service was started, 2 if the service is already running or error if the service could not be started.

Returns: quint32 pending call

Definition at line 63 of file obexmanager.cpp.

◆ unregisterAgent

PendingCall * BluezQt::ObexManager::unregisterAgent ( ObexAgent * agent )

slot

Unregisters agent.

Possible errors: PendingCall::DoesNotExist

Parameters

agent agent to be unregistered

Returns: void pending call

Definition at line 92 of file obexmanager.cpp.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About BluezQt

BluezQt::ObexManager

Properties

Signals

Public Slots

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Property Documentation

◆ initialized

◆ operational

◆ sessions

Constructor & Destructor Documentation

◆ ObexManager()

◆ ~ObexManager()

Member Function Documentation

◆ createSession

◆ init()

◆ isInitialized()

◆ isOperational()

◆ operationalChanged

◆ registerAgent

◆ removeSession

◆ sessionAdded

◆ sessionForPath()

◆ sessionRemoved

◆ sessions()

◆ startService()

◆ unregisterAgent