BluezQt 5.109.0
Properties | Signals | Public Slots | Public Member Functions | Static Public Member Functions | List of all members
BluezQt::ObexManager

OBEX manager. More...

#include <BluezQt/ObexManager>

Properties

bool initialized
 
bool operational
 
QList< ObexSessionPtr > sessions
 

Signals

void operationalChanged (bool operational)
 Indicates that operational state have changed.
 
void sessionAdded (ObexSessionPtr session)
 Indicates that the session was added.
 
void sessionRemoved (ObexSessionPtr session)
 Indicates that the session was removed.
 

Public Slots

PendingCallcreateSession (const QString &destination, const QVariantMap &args)
 Creates a new OBEX session.
 
PendingCallregisterAgent (ObexAgent *agent)
 Registers agent.
 
PendingCallremoveSession (const QDBusObjectPath &session)
 Removes an existing OBEX session.
 
PendingCallunregisterAgent (ObexAgent *agent)
 Unregisters agent.
 

Public Member Functions

 ObexManager (QObject *parent=nullptr)
 Creates a new ObexManager object.
 
 ~ObexManager () override
 Destroys an ObexManager object.
 
InitObexManagerJobinit ()
 Creates a new init job.
 
bool isInitialized () const
 Returns whether the manager is initialized.
 
bool isOperational () const
 Returns whether the manager is operational.
 
ObexSessionPtr sessionForPath (const QDBusObjectPath &path) const
 Returns a session for specified path.
 
QList< ObexSessionPtr > sessions () const
 Returns a list of all sessions.
 

Static Public Member Functions

static PendingCallstartService ()
 Attempts to start org.bluez.obex service by D-Bus activation.
 

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.

Constructor & Destructor Documentation

◆ ObexManager()

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

Creates a new ObexManager object.

Parameters
parent

◆ ~ObexManager()

BluezQt::ObexManager::~ObexManager ( )
override

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:

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

Parameters
destinationaddress of target device
argssession parameters
Returns
QDBusObjectPath pending call

◆ init()

InitObexManagerJob * BluezQt::ObexManager::init ( )

Creates a new init job.

Returns
init manager job

◆ isInitialized()

bool BluezQt::ObexManager::isInitialized ( ) const

Returns whether the manager is initialized.

Returns
true if manager is initialized

◆ 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

◆ 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
agentagent to be registered
Returns
void pending call

◆ removeSession

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

Removes an existing OBEX session.

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

Parameters
sessionsession to be removed
Returns
void pending call

◆ 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
pathpath of session
Returns
null if there is no session with specified path

◆ 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

◆ startService()

static 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

◆ unregisterAgent

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

Unregisters agent.

Possible errors: PendingCall::DoesNotExist

Parameters
agentagent to be unregistered
Returns
void pending call