org.bluez.HealthChannel1 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bluez-dbus-osgi Show documentation

Java native bluetooth library which uses bluez via dbus (linux only). This is the OSGi compliant bundle of all required libraries in one bundle.

The newest version!

package org.bluez;

import org.bluez.exceptions.*;
import org.freedesktop.dbus.FileDescriptor;
import org.freedesktop.dbus.interfaces.DBusInterface;

/**
 * File generated - 2023-02-20.

 * Based on bluez Documentation: health-api.txt.

 * 

 * Service: org.bluez

 * Interface: org.bluez.HealthChannel1

 * 

 * Object path:

 *             [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/chanZZZ

 * 

 * Supported properties: 

 * 

 * 		string Type [readonly]

 * 

 * 			The quality of service of the data channel. ("reliable"

 * 			or "streaming")

 * 

 * 		object Device [readonly]

 * 

 * 			Identifies the Remote Device that is connected with.

 * 			Maps with a HealthDevice object.

 * 

 * 		object Application [readonly]

 * 

 * 			Identifies the HealthApplication to which this channel

 * 			is related to (which indirectly defines its role and

 * 			data type).

 * 

 */
public interface HealthChannel1 extends DBusInterface {

    /**
     * From bluez documentation:

     * 

     * Returns the file descriptor for this data channel. If

     * the data channel is not connected it will also

     * reconnect.

     * 

     * 
     * @return FileDescriptor - maybe null
     * 
     * @throws BluezNotConnectedException when bluez not connected
     * @throws BluezNotAllowedException when operation not allowed
     */
    FileDescriptor Acquire() throws BluezNotConnectedException, BluezNotAllowedException;

    /**
     * From bluez documentation:

     * 

     * Releases the fd. Application should also need to

     * close() it.

     * 

     * 
     * @throws BluezNotAcquiredException when item is not acquired
     * @throws BluezNotAllowedException when operation not allowed
     */
    void Release() throws BluezNotAcquiredException, BluezNotAllowedException;

}