org.bluez.Network1 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.interfaces.DBusInterface;

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

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

 * 

 * Service: org.bluez

 * Interface: org.bluez.Network1

 * 

 * Object path:

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

 * 

 * Supported properties: 

 * 

 * 		boolean Connected [readonly]

 * 

 * 			Indicates if the device is connected.

 * 

 * 		string Interface [readonly]

 * 

 * 			Indicates the network interface name when available.

 * 

 * 		string UUID [readonly]

 * 

 * 			Indicates the connection role when available.

 * 

 * 

 * 

 */
public interface Network1 extends DBusInterface {

    /**
     * From bluez documentation:

     * 

     * Connect to the network device and return the network

     * interface name. Examples of the interface name are

     * bnep0, bnep1 etc.

     * 

     * uuid can be either one of "gn", "panu" or "nap" (case

     * insensitive) or a traditional string representation of

     * UUID or a hexadecimal number.

     * 

     * The connection will be closed and network device

     * released either upon calling Disconnect() or when

     * the client disappears from the message bus.

     * 

     * 
     * @param _uuid uuid
     * 
     * @return String - maybe null
     * 
     * @throws BluezAlreadyConnectedException when already connected
     * @throws BluezConnectionAttemptFailedException when connection attempt failed
     */
    String Connect(String _uuid) throws BluezAlreadyConnectedException, BluezConnectionAttemptFailedException;

    /**
     * From bluez documentation:

     * 

     * Disconnect from the network device.

     * 

     * To abort a connection attempt in case of errors or

     * timeouts in the client it is fine to call this method.

     * 

     * 
     * @throws BluezFailedException on failure
     */
    void Disconnect() throws BluezFailedException;

}