com.idevicesinc.sweetblue

Class BleServer

java.lang.Object

com.idevicesinc.sweetblue.BleNode

com.idevicesinc.sweetblue.BleServer

All Implemented Interfaces:

UsesCustomNull

public final class BleServer
extends BleNode

Get an instance from BleManager.getServer(). Wrapper for functionality exposed by BluetoothGattServer. For OS levels less than 5.0, this is only useful by piggybacking on an existing BleDevice that is currently BleDeviceState.BLE_CONNECTED. For OS levels 5.0 and up a BleServer is capable of acting as an independent peripheral.

Field Summary

Fields

Modifier and Type	Field and Description
static BleServer	NULL Special value that is used in place of Java's built-in null.

Fields inherited from class com.idevicesinc.sweetblue.BleNode

appData

Method Summary

Modifier and Type	Method and Description
AddServiceListener.ServiceAddEvent	addService(BleService service) Overload of addService(BleService, AddServiceListener) without the listener.
AddServiceListener.ServiceAddEvent	addService(BleService service, AddServiceListener listener) Starts the process of adding a service to this server.
ServerReconnectFilter.ConnectFailEvent	connect(java.lang.String macAddress) Overload of connect(String, ServerConnectListener, ServerReconnectFilter) with no listeners.
ServerReconnectFilter.ConnectFailEvent	connect(java.lang.String macAddress, ServerConnectListener connectListener) Overload of connect(String, ServerConnectListener, ServerReconnectFilter) with only one listener.
ServerReconnectFilter.ConnectFailEvent	connect(java.lang.String macAddress, ServerConnectListener connectListener, ServerReconnectFilter connectionFailListener) Connect to the given client mac address and provided listeners that are shorthand for calling setListener_State(ServerStateListener) setListener_ReconnectFilter(ServerReconnectFilter).
ServerReconnectFilter.ConnectFailEvent	connect(java.lang.String macAddress, ServerReconnectFilter connectionFailListener) Overload of connect(String, ServerConnectListener, ServerReconnectFilter) with only one listener.
void	disconnect() Disconnects this server completely, disconnecting all connected clients and shutting things down.
boolean	disconnect(java.lang.String macAddress)
boolean	equals(BleServer server_nullable) Does a referential equality check on the two servers.
boolean	equals(java.lang.Object object_nullable) Returns equals(BleServer) if object is an instance of BleServer.
int	getClientCount() Returns the total number of clients this server is connecting or connected to (or previously so).
int	getClientCount(BleServerState... states) Returns the number of clients that are in any of the given states.
int	getClientCount(BleServerState state) Returns the number of clients that are in the current state.
java.util.List<java.lang.String>	getClients_List() Overload of getClients() that returns a List for you.
java.util.List<java.lang.String>	getClients_List(BleServerState... states) Overload of getClients(BleServerState[]) that returns a List for you.
java.util.List<java.lang.String>	getClients_List(BleServerState state) Overload of getClients(BleServerState) that returns a List for you.
java.util.Iterator<java.lang.String>	getClients() Returns all the clients connected or connecting (or previously so) to this server.
java.util.Iterator<java.lang.String>	getClients(BleServerState... states) Returns all the clients connected or connecting (or previously so) to this server.
java.util.Iterator<java.lang.String>	getClients(BleServerState state) Returns all the clients connected or connecting (or previously so) to this server.
void	getClients(ForEach_Breakable<java.lang.String> forEach) Overload of getClients(ForEach_Void) if you need to break out of the iteration at any point.
void	getClients(ForEach_Breakable<java.lang.String> forEach, BleServerState... states) Same as getClients(ForEach_Breakable) but will only return clients in any of the given states provided.
void	getClients(ForEach_Breakable<java.lang.String> forEach, BleServerState state) Overload of getClients(ForEach_Void, BleServerState) if you need to break out of the iteration at any point.
void	getClients(ForEach_Void<java.lang.String> forEach) Offers a more "functional" means of iterating through the internal list of clients instead of using getClients() or getClients_List().
void	getClients(ForEach_Void<java.lang.String> forEach, BleServerState... states) Same as getClients(ForEach_Void) but will only return clients in any of the given states provided.
void	getClients(ForEach_Void<java.lang.String> forEach, BleServerState state) Same as getClients(ForEach_Void) but will only return clients in the given state provided.
AdvertisingListener	getListener_Advertise()
IncomingListener	getListener_Incoming() Returns the listener provided to setListener_Incoming(IncomingListener).
java.lang.String	getMacAddress() Returns the local mac address provided by BluetoothAdapter.getAddress().
java.lang.String	getName() Returns the name this BleServer is using (and will be advertised as, if applicable).
android.bluetooth.BluetoothGattServer	getNative() Provides just-in-case lower-level access to the native server instance.
IBluetoothServer	getNativeLayer() Provides just-in-case access to the abstracted server instance.
int	getStateMask(java.lang.String macAddress) Returns the bitwise state mask representation of BleServerState for the given client mac address.
boolean	hasClient(BleServerState... states) Returns true if this server has any clients in any of the given states.
boolean	hasClient(BleServerState state) Returns true if this server has any clients in the given state.
boolean	hasClients() Returns true if this server has any connected or connecting clients (or previously so).
boolean	is(java.lang.String macAddress, BleServerState state) Returns true if the given client is in the state provided.
boolean	isAdvertising() Checks to see if the device is currently advertising.
boolean	isAdvertising(java.util.UUID serviceUuid) Checks to see if the device is currently advertising the given UUID.
boolean	isAdvertisingSupported() Checks to see if the device supports advertising BLE services.
boolean	isAdvertisingSupportedByAndroidVersion() Checks to see if the device is running an Android OS which supports advertising.
boolean	isAdvertisingSupportedByChipset() Checks to see if the device supports advertising.
boolean	isAll(java.lang.String macAddress, int mask_BleServerState) Returns true if there is complete bitwise overlap between the provided value and getStateMask(String).
boolean	isAny(java.lang.String macAddress, BleServerState... states) Returns true if the given client is in any of the states provided.
boolean	isAny(java.lang.String macAddress, int mask_BleServerState) Returns true if there is any bitwise overlap between the provided value and getStateMask(String).
boolean	isNull() Returns true if the object's state represents what would otherwise be Java's built-in null.
void	removeAllServices() Convenience to remove all services previously added with addService(BleService, AddServiceListener) (or overloads).
BleService	removeService(java.util.UUID serviceUuid) Remove any service previously provided to addService(BleService, AddServiceListener) or overloads.
OutgoingListener.OutgoingEvent	sendIndication(java.lang.String macAddress, java.util.UUID charUuid, byte[] data) Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendIndication(java.lang.String macAddress, java.util.UUID charUuid, byte[] data, OutgoingListener listener) Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendIndication(java.lang.String macAddress, java.util.UUID charUuid, FutureData futureData) Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendIndication(java.lang.String macAddress, java.util.UUID charUuid, FutureData futureData, OutgoingListener listener) Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendIndication(java.lang.String macAddress, java.util.UUID serviceUuid, java.util.UUID charUuid, byte[] data) Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendIndication(java.lang.String macAddress, java.util.UUID serviceUuid, java.util.UUID charUuid, byte[] data, OutgoingListener listener) Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendIndication(java.lang.String macAddress, java.util.UUID serviceUuid, java.util.UUID charUuid, FutureData futureData) Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendIndication(java.lang.String macAddress, java.util.UUID serviceUuid, java.util.UUID charUuid, FutureData futureData, OutgoingListener listener) Same as sendNotification(String, UUID, UUID, FutureData, OutgoingListener) but sends an indication instead.
OutgoingListener.OutgoingEvent	sendNotification(java.lang.String macAddress, java.util.UUID charUuid, byte[] data) Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendNotification(java.lang.String macAddress, java.util.UUID charUuid, byte[] data, OutgoingListener listener) Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendNotification(java.lang.String macAddress, java.util.UUID charUuid, FutureData futureData) Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendNotification(java.lang.String macAddress, java.util.UUID charUuid, FutureData futureData, OutgoingListener listener) Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendNotification(java.lang.String macAddress, java.util.UUID serviceUuid, java.util.UUID charUuid, byte[] data) Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendNotification(java.lang.String macAddress, java.util.UUID serviceUuid, java.util.UUID charUuid, byte[] data, OutgoingListener listener) Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendNotification(java.lang.String macAddress, java.util.UUID serviceUuid, java.util.UUID charUuid, FutureData futureData) Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).
OutgoingListener.OutgoingEvent	sendNotification(java.lang.String macAddress, java.util.UUID serviceUuid, java.util.UUID charUuid, FutureData futureData, OutgoingListener listener) Use this method to send a notification to the client device with the given mac address to the given characteristic UUID.
void	setConfig(BleNodeConfig config_nullable) Optionally sets overrides for any custom options given to BleManager.get(android.content.Context, BleManagerConfig) for this individual server.
void	setListener_Advertising(AdvertisingListener listener_nullable)
void	setListener_Incoming(IncomingListener listener_nullable) Set a listener here to override any listener provided previously.
void	setListener_Outgoing(OutgoingListener listener) This is a default catch-all convenience listener that will be called after any listener provided through the static methods of IncomingListener.Please such as IncomingListener.Please.respondWithSuccess(OutgoingListener).
void	setListener_ReconnectFilter(ServerReconnectFilter listener) Set a listener here to override any listener provided previously.
void	setListener_ServiceAdd(AddServiceListener listener_nullable) Set a listener here to override any listener provided previously and provide a default backup that will be called after any listener provided to addService(BleService, AddServiceListener).
void	setListener_State(ServerStateListener listener_nullable) Set a listener here to be notified whenever this server's state changes in relation to a specific client.
void	setName(java.lang.String name) Set the name you wish this BleServer to be known as.
AdvertisingListener.AdvertisingEvent	startAdvertising(BleScanRecord advPacket) Overload of startAdvertising(BleScanRecord, BleAdvertisingSettings, AdvertisingListener).
AdvertisingListener.AdvertisingEvent	startAdvertising(BleScanRecord advPacket, AdvertisingListener listener) Overload of startAdvertising(BleScanRecord, BleAdvertisingSettings, AdvertisingListener).
AdvertisingListener.AdvertisingEvent	startAdvertising(BleScanRecord advertisePacket, BleAdvertisingSettings settings, AdvertisingListener listener) Starts advertising serviceUuids with the information supplied in BleScanRecord.
AdvertisingListener.AdvertisingEvent	startAdvertising(java.util.UUID serviceUuid) Overload of startAdvertising(BleScanRecord).
AdvertisingListener.AdvertisingEvent	startAdvertising(java.util.UUID[] serviceUuids) Overload of startAdvertising(BleScanRecord).
AdvertisingListener.AdvertisingEvent	startAdvertising(java.util.UUID[] serviceUuids, AdvertisingListener listener) Overload of startAdvertising(BleScanRecord, AdvertisingListener).
AdvertisingListener.AdvertisingEvent	startAdvertising(java.util.UUID[] serviceUuids, BleAdvertisingSettings settings, AdvertisingListener listener) Overload of startAdvertising(BleScanRecord, BleAdvertisingSettings, AdvertisingListener).
AdvertisingListener.AdvertisingEvent	startAdvertising(java.util.UUID[] serviceUuids, BleScanRecord.Option... options) Overload of startAdvertising(BleScanRecord).
AdvertisingListener.AdvertisingEvent	startAdvertising(java.util.UUID serviceUuid, AdvertisingListener listener) Overload of startAdvertising(BleScanRecord, AdvertisingListener).
AdvertisingListener.AdvertisingEvent	startAdvertising(java.util.UUID serviceUuid, BleAdvertisingSettings settings, AdvertisingListener listener) Overload of startAdvertising(BleScanRecord, BleAdvertisingSettings, AdvertisingListener).
AdvertisingListener.AdvertisingEvent	startAdvertising(java.util.UUID serviceUuid, BleScanRecord.Option... options) Overload of startAdvertising(BleScanRecord).
AdvertisingListener.AdvertisingEvent	startAdvertising(java.util.UUID serviceUuid, byte[] serviceData) Overload of startAdvertising(BleScanRecord).
AdvertisingListener.AdvertisingEvent	startAdvertising(java.util.UUID serviceUuid, byte[] serviceData, BleScanRecord.Option... options) Overload of startAdvertising(BleScanRecord).
void	stopAdvertising() Stops the server from advertising.
java.lang.String	toString() Pretty-prints the list of connecting or connected clients.

Methods inherited from class com.idevicesinc.sweetblue.BleNode

appData, cast, cast, getManager, getNativeBleCharacteristic, getNativeBleCharacteristic, getNativeBleDescriptor_inChar, getNativeBleDescriptor_inService, getNativeBleDescriptor, getNativeBleDescriptor, getNativeBleService, getNativeCharacteristic, getNativeCharacteristics_List, getNativeCharacteristics_List, getNativeCharacteristics, getNativeCharacteristics, getNativeCharacteristics, getNativeCharacteristics, getNativeCharacteristics, getNativeCharacteristics, getNativeDescriptors_inChar_List, getNativeDescriptors_inChar, getNativeDescriptors_inChar, getNativeDescriptors_inChar, getNativeDescriptors_inService_List, getNativeDescriptors_inService, getNativeDescriptors_inService, getNativeDescriptors_inService, getNativeDescriptors_List, getNativeDescriptors_List, getNativeDescriptors, getNativeDescriptors, getNativeDescriptors, getNativeDescriptors, getNativeDescriptors, getNativeDescriptors, getNativeServices_List, getNativeServices, getNativeServices, getNativeServices, newHistoricalData, queryHistoricalData, queryHistoricalData, select

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NULL

public static final BleServer NULL

Special value that is used in place of Java's built-in null.

Method Detail

setConfig

public final void setConfig(BleNodeConfig config_nullable)

Optionally sets overrides for any custom options given to BleManager.get(android.content.Context, BleManagerConfig) for this individual server.

setListener_State

public final void setListener_State(ServerStateListener listener_nullable)

Set a listener here to be notified whenever this server's state changes in relation to a specific client.

setListener_Incoming

public final void setListener_Incoming(IncomingListener listener_nullable)

Set a listener here to override any listener provided previously.

setListener_ServiceAdd

public final void setListener_ServiceAdd(AddServiceListener listener_nullable)

Set a listener here to override any listener provided previously and provide a default backup that will be called after any listener provided to addService(BleService, AddServiceListener).

setListener_Advertising

public final void setListener_Advertising(AdvertisingListener listener_nullable)

getListener_Advertise

public final AdvertisingListener getListener_Advertise()

getListener_Incoming

public final IncomingListener getListener_Incoming()

Returns the listener provided to setListener_Incoming(IncomingListener).

setListener_Outgoing

public final void setListener_Outgoing(OutgoingListener listener)

This is a default catch-all convenience listener that will be called after any listener provided through the static methods of IncomingListener.Please such as IncomingListener.Please.respondWithSuccess(OutgoingListener).

See Also:

BleManager.setListener_Outgoing(OutgoingListener)

setListener_ReconnectFilter

public final void setListener_ReconnectFilter(ServerReconnectFilter listener)

Set a listener here to override any listener provided previously.

sendIndication

public final OutgoingListener.OutgoingEvent sendIndication(java.lang.String macAddress,
                                                           java.util.UUID charUuid,
                                                           byte[] data)

Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).

sendIndication

public final OutgoingListener.OutgoingEvent sendIndication(java.lang.String macAddress,
                                                           java.util.UUID charUuid,
                                                           byte[] data,
                                                           OutgoingListener listener)

Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).

sendIndication

public final OutgoingListener.OutgoingEvent sendIndication(java.lang.String macAddress,
                                                           java.util.UUID serviceUuid,
                                                           java.util.UUID charUuid,
                                                           byte[] data)

Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).

sendIndication

public final OutgoingListener.OutgoingEvent sendIndication(java.lang.String macAddress,
                                                           java.util.UUID serviceUuid,
                                                           java.util.UUID charUuid,
                                                           byte[] data,
                                                           OutgoingListener listener)

Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).

sendIndication

public final OutgoingListener.OutgoingEvent sendIndication(java.lang.String macAddress,
                                                           java.util.UUID charUuid,
                                                           FutureData futureData)

Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).

sendIndication

public final OutgoingListener.OutgoingEvent sendIndication(java.lang.String macAddress,
                                                           java.util.UUID charUuid,
                                                           FutureData futureData,
                                                           OutgoingListener listener)

Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).

sendIndication

public final OutgoingListener.OutgoingEvent sendIndication(java.lang.String macAddress,
                                                           java.util.UUID serviceUuid,
                                                           java.util.UUID charUuid,
                                                           FutureData futureData)

Overload of sendIndication(String, UUID, UUID, FutureData, OutgoingListener).

sendIndication

public final OutgoingListener.OutgoingEvent sendIndication(java.lang.String macAddress,
                                                           java.util.UUID serviceUuid,
                                                           java.util.UUID charUuid,
                                                           FutureData futureData,
                                                           OutgoingListener listener)

Same as sendNotification(String, UUID, UUID, FutureData, OutgoingListener) but sends an indication instead.

sendNotification

public final OutgoingListener.OutgoingEvent sendNotification(java.lang.String macAddress,
                                                             java.util.UUID charUuid,
                                                             byte[] data)

Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).

sendNotification

public final OutgoingListener.OutgoingEvent sendNotification(java.lang.String macAddress,
                                                             java.util.UUID charUuid,
                                                             byte[] data,
                                                             OutgoingListener listener)

Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).

sendNotification

public final OutgoingListener.OutgoingEvent sendNotification(java.lang.String macAddress,
                                                             java.util.UUID serviceUuid,
                                                             java.util.UUID charUuid,
                                                             byte[] data)

Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).

sendNotification

public final OutgoingListener.OutgoingEvent sendNotification(java.lang.String macAddress,
                                                             java.util.UUID serviceUuid,
                                                             java.util.UUID charUuid,
                                                             byte[] data,
                                                             OutgoingListener listener)

Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).

sendNotification

public final OutgoingListener.OutgoingEvent sendNotification(java.lang.String macAddress,
                                                             java.util.UUID charUuid,
                                                             FutureData futureData)

Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).

sendNotification

public final OutgoingListener.OutgoingEvent sendNotification(java.lang.String macAddress,
                                                             java.util.UUID charUuid,
                                                             FutureData futureData,
                                                             OutgoingListener listener)

Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).

sendNotification

public final OutgoingListener.OutgoingEvent sendNotification(java.lang.String macAddress,
                                                             java.util.UUID serviceUuid,
                                                             java.util.UUID charUuid,
                                                             FutureData futureData)

Overload of sendNotification(String, UUID, UUID, FutureData, OutgoingListener).

sendNotification

public final OutgoingListener.OutgoingEvent sendNotification(java.lang.String macAddress,
                                                             java.util.UUID serviceUuid,
                                                             java.util.UUID charUuid,
                                                             FutureData futureData,
                                                             OutgoingListener listener)

Use this method to send a notification to the client device with the given mac address to the given characteristic UUID. If there is any kind of "early-out" issue then this method will return a OutgoingListener.OutgoingEvent in addition to passing it through the listener. Otherwise this method will return an instance with OutgoingListener.OutgoingEvent.isNull() being true.

isAdvertisingSupportedByAndroidVersion

public final boolean isAdvertisingSupportedByAndroidVersion()

Checks to see if the device is running an Android OS which supports advertising. This is forwarded from BleManager.isAdvertisingSupportedByAndroidVersion().

isAdvertisingSupportedByChipset

public final boolean isAdvertisingSupportedByChipset()

Checks to see if the device supports advertising. This is forwarded from BleManager.isAdvertisingSupportedByChipset().

isAdvertisingSupported

public final boolean isAdvertisingSupported()

Checks to see if the device supports advertising BLE services. This is forwarded from BleManager.isAdvertisingSupported().

isAdvertising

public final boolean isAdvertising()

Checks to see if the device is currently advertising.

isAdvertising

public final boolean isAdvertising(java.util.UUID serviceUuid)

Checks to see if the device is currently advertising the given UUID.

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(java.util.UUID serviceUuid)

Overload of startAdvertising(BleScanRecord).

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(java.util.UUID serviceUuid,
                                                                   AdvertisingListener listener)

Overload of startAdvertising(BleScanRecord, AdvertisingListener).

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(java.util.UUID[] serviceUuids)

Overload of startAdvertising(BleScanRecord).

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(java.util.UUID[] serviceUuids,
                                                                   AdvertisingListener listener)

Overload of startAdvertising(BleScanRecord, AdvertisingListener).

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(java.util.UUID serviceUuid,
                                                                   byte[] serviceData)

Overload of startAdvertising(BleScanRecord).

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(java.util.UUID serviceUuid,
                                                                   byte[] serviceData,
                                                                   BleScanRecord.Option... options)

Overload of startAdvertising(BleScanRecord).

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(java.util.UUID serviceUuid,
                                                                   BleScanRecord.Option... options)

Overload of startAdvertising(BleScanRecord).

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(java.util.UUID[] serviceUuids,
                                                                   BleScanRecord.Option... options)

Overload of startAdvertising(BleScanRecord).

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(java.util.UUID serviceUuid,
                                                                   BleAdvertisingSettings settings,
                                                                   AdvertisingListener listener)

Overload of startAdvertising(BleScanRecord, BleAdvertisingSettings, AdvertisingListener).

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(java.util.UUID[] serviceUuids,
                                                                   BleAdvertisingSettings settings,
                                                                   AdvertisingListener listener)

Overload of startAdvertising(BleScanRecord, BleAdvertisingSettings, AdvertisingListener).

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(BleScanRecord advPacket)

Overload of startAdvertising(BleScanRecord, BleAdvertisingSettings, AdvertisingListener). This sets the BleAdvertisingSettings.BleAdvertisingMode to BleAdvertisingSettings.BleAdvertisingMode.AUTO, and BleAdvertisingSettings.BleTransmissionPower to BleAdvertisingSettings.BleTransmissionPower.MEDIUM, and no timeout for the advertisement.

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(BleScanRecord advPacket,
                                                                   AdvertisingListener listener)

Overload of startAdvertising(BleScanRecord, BleAdvertisingSettings, AdvertisingListener). This sets the BleAdvertisingSettings.BleAdvertisingMode to BleAdvertisingSettings.BleAdvertisingMode.AUTO, and BleAdvertisingSettings.BleTransmissionPower to BleAdvertisingSettings.BleTransmissionPower.MEDIUM, and no timeout for the advertisement.

startAdvertising

public final AdvertisingListener.AdvertisingEvent startAdvertising(BleScanRecord advertisePacket,
                                                                   BleAdvertisingSettings settings,
                                                                   AdvertisingListener listener)

Starts advertising serviceUuids with the information supplied in BleScanRecord. Note that this will only work for devices on Lollipop, or above. Even then, not every device supports advertising. Use BleManager.isAdvertisingSupported() to check to see if the phone supports it.

stopAdvertising

public final void stopAdvertising()

Stops the server from advertising.

getName

public final java.lang.String getName()

Returns the name this BleServer is using (and will be advertised as, if applicable).

setName

public final void setName(java.lang.String name)

Set the name you wish this BleServer to be known as. This will affect how other devices see this server, and sets the name on the lower level BluetoothAdapter. If you DO change this, please be aware this will affect everything, including apps outside of your own. It's probably best NOT to use this, but it's here for flexibility.

getNative

public final android.bluetooth.BluetoothGattServer getNative()

Provides just-in-case lower-level access to the native server instance. See similar warning for BleDevice.getNative().

getNativeLayer

public final IBluetoothServer getNativeLayer()

Provides just-in-case access to the abstracted server instance. See similar warning for BleDevice.getNative().

getStateMask

public final int getStateMask(java.lang.String macAddress)

Returns the bitwise state mask representation of BleServerState for the given client mac address.

See Also:

BleServerState

isAny

public final boolean isAny(java.lang.String macAddress,
                           int mask_BleServerState)

Returns true if there is any bitwise overlap between the provided value and getStateMask(String).

See Also:

isAll(String, int)

isAll

public final boolean isAll(java.lang.String macAddress,
                           int mask_BleServerState)

Returns true if there is complete bitwise overlap between the provided value and getStateMask(String).

See Also:

isAny(String, int)

is

public final boolean is(java.lang.String macAddress,
                        BleServerState state)

Returns true if the given client is in the state provided.

isAny

public final boolean isAny(java.lang.String macAddress,
                           BleServerState... states)

Returns true if the given client is in any of the states provided.

connect

public final ServerReconnectFilter.ConnectFailEvent connect(java.lang.String macAddress)

Overload of connect(String, ServerConnectListener, ServerReconnectFilter) with no listeners.

connect

public final ServerReconnectFilter.ConnectFailEvent connect(java.lang.String macAddress,
                                                            ServerConnectListener connectListener)

Overload of connect(String, ServerConnectListener, ServerReconnectFilter) with only one listener.

connect

public final ServerReconnectFilter.ConnectFailEvent connect(java.lang.String macAddress,
                                                            ServerReconnectFilter connectionFailListener)

Overload of connect(String, ServerConnectListener, ServerReconnectFilter) with only one listener.

connect

public final ServerReconnectFilter.ConnectFailEvent connect(java.lang.String macAddress,
                                                            ServerConnectListener connectListener,
                                                            ServerReconnectFilter connectionFailListener)

Connect to the given client mac address and provided listeners that are shorthand for calling setListener_State(ServerStateListener) setListener_ReconnectFilter(ServerReconnectFilter).

disconnect

public final boolean disconnect(java.lang.String macAddress)

disconnect

public final void disconnect()

Disconnects this server completely, disconnecting all connected clients and shutting things down. To disconnect individual clients use disconnect(String).

isNull

public final boolean isNull()

Description copied from interface: UsesCustomNull

Returns true if the object's state represents what would otherwise be Java's built-in null.

equals

public final boolean equals(BleServer server_nullable)

Does a referential equality check on the two servers.

equals

public final boolean equals(java.lang.Object object_nullable)

Returns equals(BleServer) if object is an instance of BleServer. Otherwise calls super.

Overrides:

equals in class java.lang.Object

See Also:

equals(BleServer)

addService

public final AddServiceListener.ServiceAddEvent addService(BleService service)

Overload of addService(BleService, AddServiceListener) without the listener.

addService

public final AddServiceListener.ServiceAddEvent addService(BleService service,
                                                           AddServiceListener listener)

Starts the process of adding a service to this server. The provided listener will be called when the service is added or there is a problem.

removeService

public final BleService removeService(java.util.UUID serviceUuid)

Remove any service previously provided to addService(BleService, AddServiceListener) or overloads. This can be safely called even if the call to addService(BleService, AddServiceListener) hasn't resulted in a callback to the provided listener yet, in which case it will be called with AddServiceListener.Status.CANCELLED_FROM_REMOVAL.

removeAllServices

public final void removeAllServices()

Convenience to remove all services previously added with addService(BleService, AddServiceListener) (or overloads). This is slightly more performant too.

getClients

public final void getClients(ForEach_Void<java.lang.String> forEach)

Offers a more "functional" means of iterating through the internal list of clients instead of using getClients() or getClients_List().

getClients

public final void getClients(ForEach_Void<java.lang.String> forEach,
                             BleServerState state)

Same as getClients(ForEach_Void) but will only return clients in the given state provided.

getClients

public final void getClients(ForEach_Void<java.lang.String> forEach,
                             BleServerState... states)

Same as getClients(ForEach_Void) but will only return clients in any of the given states provided.

getClients

public final void getClients(ForEach_Breakable<java.lang.String> forEach)

Overload of getClients(ForEach_Void) if you need to break out of the iteration at any point.

getClients

public final void getClients(ForEach_Breakable<java.lang.String> forEach,
                             BleServerState state)

Overload of getClients(ForEach_Void, BleServerState) if you need to break out of the iteration at any point.

getClients

public final void getClients(ForEach_Breakable<java.lang.String> forEach,
                             BleServerState... states)

Same as getClients(ForEach_Breakable) but will only return clients in any of the given states provided.

getClients

public final java.util.Iterator<java.lang.String> getClients()

Returns all the clients connected or connecting (or previously so) to this server.

getClients

public final java.util.Iterator<java.lang.String> getClients(BleServerState state)

Returns all the clients connected or connecting (or previously so) to this server.

getClients

public final java.util.Iterator<java.lang.String> getClients(BleServerState... states)

Returns all the clients connected or connecting (or previously so) to this server.

getClients_List

public final java.util.List<java.lang.String> getClients_List()

Overload of getClients() that returns a List for you.

getClients_List

public final java.util.List<java.lang.String> getClients_List(BleServerState state)

Overload of getClients(BleServerState) that returns a List for you.

getClients_List

public final java.util.List<java.lang.String> getClients_List(BleServerState... states)

Overload of getClients(BleServerState[]) that returns a List for you.

getClientCount

public final int getClientCount()

Returns the total number of clients this server is connecting or connected to (or previously so).

getClientCount

public final int getClientCount(BleServerState state)

Returns the number of clients that are in the current state.

getClientCount

public final int getClientCount(BleServerState... states)

Returns the number of clients that are in any of the given states.

hasClients

public final boolean hasClients()

Returns true if this server has any connected or connecting clients (or previously so).

hasClient

public final boolean hasClient(BleServerState state)

Returns true if this server has any clients in the given state.

hasClient

public final boolean hasClient(BleServerState... states)

Returns true if this server has any clients in any of the given states.

toString

public final java.lang.String toString()

Pretty-prints the list of connecting or connected clients.

Overrides:

toString in class java.lang.Object

getMacAddress

public final java.lang.String getMacAddress()

Returns the local mac address provided by BluetoothAdapter.getAddress().

Specified by:

getMacAddress in class BleNode