direct_bt::BTGattService Class Reference

Representing a complete [Primary] Service Declaration including its list of Characteristic Declarations, which also may include its client config if available. More...

#include <BTGattService.hpp>

Inheritance diagram for direct_bt::BTGattService:

Collaboration diagram for direct_bt::BTGattService:

Public Member Functions
	BTGattService (const std::shared_ptr< BTGattHandler > &handler_, const bool isPrimary_, const uint16_t startHandle_, const uint16_t endHandle_, std::unique_ptr< const uuid_t > &&type_) noexcept
std::string	get_java_class () const noexcept override
std::shared_ptr< BTGattHandler >	getGattHandlerUnchecked () const noexcept
std::shared_ptr< BTGattHandler >	getGattHandlerChecked () const
std::shared_ptr< BTDevice >	getDeviceUnchecked () const noexcept
std::shared_ptr< BTDevice >	getDeviceChecked () const
std::string	toString () const noexcept override
Public Member Functions inherited from direct_bt::BTObject
virtual	~BTObject () noexcept
bool	isValid () const noexcept
	Returns whether the object's reference is valid and in a general operational state. More...
Public Member Functions inherited from jau::JavaUplink
std::string	javaObjectToString () const noexcept
std::shared_ptr< JavaAnon >	getJavaObject () noexcept
void	setJavaObject (std::shared_ptr< JavaAnon > objRef) noexcept
	Assigns a new shared JavaAnon reference, replaced item might be deleted via JNI from dtor. More...
void	setJavaObject () noexcept
	Resets the shared JavaAnon reference, the replaced item might be deleted via JNI from dtor. More...
void	clearJavaObject () noexcept
	Clears the java reference, i.e. More...
virtual void	checkValid () const
	Throws an IllegalStateException if isValid() == false. More...
virtual	~JavaUplink () noexcept

Static Public Member Functions
static std::string	java_class () noexcept

Public Attributes
const bool	isPrimary
const uint16_t	startHandle
	Service start handle. More...
const uint16_t	endHandle
	Service end handle. More...
std::unique_ptr< const uuid_t >	type
	Service type UUID. More...
jau::darray< BTGattCharRef >	characteristicList
	List of Characteristic Declarations as shared reference. More...

Additional Inherited Members
Protected Member Functions inherited from direct_bt::BTObject
	BTObject () noexcept
Protected Attributes inherited from direct_bt::BTObject
std::atomic_bool	valid

Detailed Description

Representing a complete [Primary] Service Declaration including its list of Characteristic Declarations, which also may include its client config if available.

Examples

dbt_scanner00.cpp, dbt_scanner01.cpp, and dbt_scanner10.cpp.

Definition at line 67 of file BTGattService.hpp.

Constructor & Destructor Documentation

BTGattService()

direct_bt::BTGattService::BTGattService ( const std::shared_ptr< BTGattHandler > &  handler_, const bool  isPrimary_, const uint16_t  startHandle_, const uint16_t  endHandle_, std::unique_ptr< const uuid_t > &&  type_  )

inlinenoexcept

Definition at line 99 of file BTGattService.hpp.

Here is the call graph for this function:

Member Function Documentation

get_java_class()

std::string direct_bt::BTGattService::get_java_class ( ) const

inlineoverridevirtualnoexcept

Implements jau::JavaUplink.

Definition at line 105 of file BTGattService.hpp.

Here is the call graph for this function:

getDeviceChecked()

std::shared_ptr< BTDevice > BTGattService::getDeviceChecked

(

)

const

Definition at line 62 of file BTGattService.cpp.

getDeviceUnchecked()

std::shared_ptr< BTDevice > BTGattService::getDeviceUnchecked ( ) const

noexcept

Definition at line 54 of file BTGattService.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getGattHandlerChecked()

std::shared_ptr< BTGattHandler > BTGattService::getGattHandlerChecked

(

)

const

Definition at line 46 of file BTGattService.cpp.

getGattHandlerUnchecked()

std::shared_ptr<BTGattHandler> direct_bt::BTGattService::getGattHandlerUnchecked ( ) const

inlinenoexcept

Definition at line 112 of file BTGattService.hpp.

Here is the caller graph for this function:

java_class()

static std::string direct_bt::BTGattService::java_class ( )

inlinestaticnoexcept

Definition at line 108 of file BTGattService.hpp.

Here is the caller graph for this function:

toString()

std::string BTGattService::toString ( ) const

overridevirtualnoexcept

Reimplemented from direct_bt::BTObject.

Examples

dbt_scanner00.cpp, dbt_scanner01.cpp, and dbt_scanner10.cpp.

Definition at line 66 of file BTGattService.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

characteristicList

jau::darray<BTGattCharRef> direct_bt::BTGattService::characteristicList

List of Characteristic Declarations as shared reference.

Examples

dbt_scanner00.cpp, dbt_scanner01.cpp, and dbt_scanner10.cpp.

Definition at line 97 of file BTGattService.hpp.

endHandle

const uint16_t direct_bt::BTGattService::endHandle

Service end handle.

Attribute handles are unique for each device (server) (BT Core Spec v5.2: Vol 3, Part F Protocol..: 3.2.2 Attribute Handle).

Definition at line 91 of file BTGattService.hpp.

isPrimary

const bool direct_bt::BTGattService::isPrimary

Definition at line 75 of file BTGattService.hpp.

startHandle

const uint16_t direct_bt::BTGattService::startHandle

Service start handle.

Attribute handles are unique for each device (server) (BT Core Spec v5.2: Vol 3, Part F Protocol..: 3.2.2 Attribute Handle).

Definition at line 83 of file BTGattService.hpp.

type

std::unique_ptr<const uuid_t> direct_bt::BTGattService::type

Service type UUID.

Examples

dbt_scanner10.cpp.

Definition at line 94 of file BTGattService.hpp.

---

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

• /usr/local/projects/direct_bt/api/direct_bt/BTGattService.hpp
• /usr/local/projects/direct_bt/src/direct_bt/BTGattService.cpp