Bluetooth GATT(Generic Attribute Profile) API provides functions for modifying attributes and registering services, characteristics and descriptors.

Required Header

#include <bluetooth.h>

Overview

Two roles are defined for devices that implement GATT. The Server is the device that accepts incoming commands and requests from a client and sends responses, indications and notifications to the client. The Client is the device that initiates commands and requests towards a server and can receive responses, indications and notifications sent by the server.

Related Features

This API is related with the following features:

http://tizen.org/feature/network.bluetooth.le

It is recommended to create an application with regard to features, to increase reliability.

You can check if a device supports the related features for this API by using System Information, thereby controlling the procedure of your application.

To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.

More details on featuring your application can be found from Feature Element.

Functions
int	bt_gatt_service_destroy (bt_gatt_h gatt_handle)
	Destroys the GATT handle of service.
int	bt_gatt_characteristic_destroy (bt_gatt_h gatt_handle)
	Destroys the GATT handle of characteristic.
int	bt_gatt_descriptor_destroy (bt_gatt_h gatt_handle)
	Destroys the GATT handle of descriptor.
int	bt_gatt_characteristic_get_permissions (bt_gatt_h gatt_handle, int *permissions)
	Gets the permissions which a characteristic's GATT handle has.
int	bt_gatt_descriptor_get_permissions (bt_gatt_h gatt_handle, int *permissions)
	Gets the permissions which a descriptor's GATT handle has.
int	bt_gatt_service_create (const char uuid, bt_gatt_service_type_e type, bt_gatt_h service)
	Creates the GATT service.
int	bt_gatt_service_add_characteristic (bt_gatt_h service, bt_gatt_h characteristic)
	Adds a characteristic to a specified service.
int	bt_gatt_service_add_included_service (bt_gatt_h service, bt_gatt_h included_service)
	Adds a service to a specified service as included service.
int	bt_gatt_service_get_server (bt_gatt_h service, bt_gatt_server_h *server)
	Gets the GATT server handle to which the specified service belongs.
int	bt_gatt_characteristic_create (const char uuid, int permissions, int properties, const char value, int value_length, bt_gatt_h *characteristic)
	Creates the GATT characteristic.
int	bt_gatt_characteristic_add_descriptor (bt_gatt_h characteristic, bt_gatt_h descriptor)
	Adds a descriptor to a specified characteristic.
int	bt_gatt_descriptor_create (const char uuid, int permissions, const char value, int value_length, bt_gatt_h *descriptor)
	Creates the GATT characteristic descriptor.
int	bt_gatt_server_initialize (void)
	Initializes the GATT Server.
int	bt_gatt_server_deinitialize (void)
	DeInitializes the GATT server.
int	bt_gatt_server_create (bt_gatt_server_h *server)
	Creates the GATT server's handle.
int	bt_gatt_server_destroy (bt_gatt_server_h server)
	Destroys the GATT server's handle.
int	bt_gatt_server_set_read_value_requested_cb (bt_gatt_h gatt_handle, bt_gatt_server_read_value_requested_cb callback, void *user_data)
	Registers a callback function to be invoked when a read request for a specified characteristic or descriptor is issued from a remote device(GATT client).
int	bt_gatt_server_set_characteristic_notification_state_change_cb (bt_gatt_h gatt_handle, bt_gatt_server_characteristic_notification_state_changed_cb callback, void *user_data)
	Registers a callback function to be invoked when the remote device enables or disables the Notification/Indication for particular characteristics.
int	bt_gatt_server_set_write_value_requested_cb (bt_gatt_h gatt_handle, bt_gatt_server_write_value_requested_cb callback, void *user_data)
	Registers a callback function to be invoked when a value of a characteristic or descriptor has been changed by a remote device(GATT client)'s request.
int	bt_gatt_server_register_service (bt_gatt_server_h server, bt_gatt_h service)
	Registers a specified service to the specified GATT server that the local device is hosting.
int	bt_gatt_server_unregister_service (bt_gatt_server_h server, bt_gatt_h service)
	Unregisters a specified service from the specified GATT server that the local device is hosting.
int	bt_gatt_server_unregister_all_services (bt_gatt_server_h server)
	Unregisters all services from the specified GATT server that the local device is hosting.
int	bt_gatt_server_start (void)
	Registers the application along with the GATT services of the application it is hosting.
int	bt_gatt_server_send_response (int request_id, bt_gatt_att_request_type_e request_type, int offset, int resp_status, char *value, int value_length)
	Sends a response to the remote device as a result of a read/write request.
int	bt_gatt_server_notify_characteristic_changed_value (bt_gatt_h characteristic, bt_gatt_server_notification_sent_cb callback, const char device_address, void user_data)
	Notifies value change of the characteristic to the remote devices which enable a Client Characteristic Configuration Descriptor.
int	bt_gatt_server_get_service (bt_gatt_server_h server, const char uuid, bt_gatt_h service)
	Gets a service's GATT handle which has specific UUID.
int	bt_gatt_server_foreach_services (bt_gatt_server_h server, bt_gatt_foreach_cb callback, void *user_data)
	Invokes callback function on each service that belongs to the specified GATT server.
Typedefs
typedef void *	bt_gatt_server_h
	The handle of a GATT server.
typedef void(*	bt_gatt_server_write_value_requested_cb )(const char remote_address, int request_id, bt_gatt_server_h server, bt_gatt_h gatt_handle, bool response_needed, int offset, const char value, int len, void *user_data)
	Called when a value of a characteristic or descriptor's GATT handle has been changed.
typedef void(*	bt_gatt_server_read_value_requested_cb )(const char remote_address, int request_id, bt_gatt_server_h server, bt_gatt_h gatt_handle, int offset, void user_data)
	Called when the remote device requests to read a value on a GATT server.
typedef void(*	bt_gatt_server_characteristic_notification_state_changed_cb )(bool notify, bt_gatt_server_h server, bt_gatt_h gatt_handle, void *user_data)
	Called when the remote device enables or disables the Notification/Indication for particular characteristics.
typedef void(*	bt_gatt_server_notification_sent_cb )(int result, const char remote_address, bt_gatt_server_h server, bt_gatt_h characteristic, bool completed, void user_data)
	Called when the sending notification / indication is done.

Typedef Documentation

typedef void(* bt_gatt_server_characteristic_notification_state_changed_cb)(bool notify, bt_gatt_server_h server, bt_gatt_h gatt_handle, void *user_data)

Called when the remote device enables or disables the Notification/Indication for particular characteristics.

Since :: 3.0

By using this callback function, server can know notification state.

Remarks:: The server must not be freed by application.; The gatt_handle must not be freed by application.

Parameters:

[in]	notify	Indicates whether the Notification/Indication is enabled or not
[in]	server	The GATT server handle
[in]	gatt_handle	The characteristic's GATT handle to be read
[in]	user_data	The user data passed from the registration function

See also:: bt_gatt_server_set_read_value_requested_cb()

typedef void* bt_gatt_server_h

The handle of a GATT server.

Since :: 3.0

typedef void(* bt_gatt_server_notification_sent_cb)(int result, const char *remote_address, bt_gatt_server_h server, bt_gatt_h characteristic, bool completed, void *user_data)

Called when the sending notification / indication is done.

Since :: 3.0

Remarks:: The remote_address must not be freed by application.; The server must not be freed by application.; The characteristic must not be freed by application.; In case of an indication, once a confirmation is received from the remote device this callback will be called.
This callback will be called several times if there are two or more remote devices which enable a Client Characteristic Configuration Descriptor(CCCD).
For the last remote device, completed will be set as true.

Parameters:

[in]	result	The result of a sending operation
[in]	remote_address	The address of the remote device
[in]	server	The GATT server handle
[in]	characteristic	The characteristic's GATT handle
[in]	completed	If this callback is for the last remote device which enables a CCCD, it will be true. Or it will be false.
[in]	user_data	The user data passed from the requesting function

See also:: bt_gatt_server_notify_characteristic_changed_value()

typedef void(* bt_gatt_server_read_value_requested_cb)(const char *remote_address, int request_id, bt_gatt_server_h server, bt_gatt_h gatt_handle, int offset, void *user_data)

Called when the remote device requests to read a value on a GATT server.

Since :: 3.0

For finishing the request, call the function bt_gatt_server_send_response in callback.

Remarks:: The remote_address must not be freed by application.; The server must not be freed by application.; The gatt_handle must not be freed by application.

Parameters:

[in]	remote_address	The address of the requesting remote device
[in]	request_id	The identification of this request. It will be used to send a response.
[in]	server	The GATT server handle
[in]	gatt_handle	The characteristic or descriptor's GATT handle to be read
[in]	offset	The requested offset from where the GATT handle's value is read
[in]	user_data	The user data passed from the registration function

See also:: bt_gatt_server_set_read_value_requested_cb(); bt_gatt_server_send_response()

typedef void(* bt_gatt_server_write_value_requested_cb)(const char *remote_address, int request_id, bt_gatt_server_h server, bt_gatt_h gatt_handle, bool response_needed, int offset, const char *value, int len, void *user_data)

Called when a value of a characteristic or descriptor's GATT handle has been changed.

Since :: 3.0

For finishing the request, call the function bt_gatt_server_send_response in callback.

Remarks:: After this function is returned, a changed value is automatically applied to gatt_handle. Before that, gatt_handle has an old value.; The remote_address must not be freed by application.; The server must not be freed by application.; The gatt_handle must not be freed by application.; The value must not be freed by application.

Parameters:

[in]	remote_address	The address of the remote device which requests a change
[in]	request_id	The identification of this request. It will be used to send a response.
[in]	server	The GATT server handle
[in]	gatt_handle	The characteristic or descriptor's GATT handle which has an old value
[in]	response_needed	Indicates whether a response is required by the remote device - `true` if required, `false` if not
[in]	offset	The requested offset from where the gatt_handle value will be updated
[in]	value	The new value
[in]	len	The length of value
[in]	user_data	The user data passed from the registration function

See also:: bt_gatt_server_set_write_value_requested_cb(); bt_gatt_server_send_response()

Enumeration Type Documentation

enum bt_gatt_att_request_type_e

Enumerations of the remote device request types for attributes.

Since :: 3.0

enum bt_gatt_permission_e

Enumerations of the attribute's permission.

Since :: 3.0

Enumerator:

BT_GATT_PERMISSION_READ	Readable permission
BT_GATT_PERMISSION_WRITE	Writable permission
BT_GATT_PERMISSION_ENCRYPT_READ	Readable permission required encryption
BT_GATT_PERMISSION_ENCRYPT_WRITE	Writable permission required encryption
BT_GATT_PERMISSION_ENCRYPT_AUTHENTICATED_READ	Readable permission required encryption and authentication
BT_GATT_PERMISSION_ENCRYPT_AUTHENTICATED_WRITE	Writable permission required encryption and authentication

Function Documentation

int bt_gatt_characteristic_add_descriptor	(	bt_gatt_h	characteristic,
		bt_gatt_h	descriptor
	)

Adds a descriptor to a specified characteristic.

Since :: 3.0

Parameters:

[in]	characteristic	The GATT handle of the characteristic
[in]	descriptor	The descriptor's GATT handle to be added

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_characteristic_create(); bt_gatt_descriptor_create()

int bt_gatt_characteristic_create	(	const char *	uuid,
		int	permissions,
		int	properties,
		const char *	value,
		int	value_length,
		bt_gatt_h *	characteristic
	)

Creates the GATT characteristic.

Since :: 3.0

Remarks:: The permissions can be one or more values of bt_gatt_permission_e, combined with bitwise 'or'.; The properties can be one or more values of bt_gatt_property_e, combined with bitwise 'or'.; The characteristic should be destroyed by using bt_gatt_characteristic_destroy().

Parameters:

[in]	uuid	The UUID of the characteristic
[in]	permissions	The permissions of the characteristic
[in]	properties	The properties of the characteristic
[in]	value	The value(byte stream) of the characteristic
[in]	value_length	The length of value
[out]	characteristic	The GATT handle of the created characteristic

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_OUT_OF_MEMORY	Out of memory
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_characteristic_destroy()

int bt_gatt_characteristic_destroy ( bt_gatt_h gatt_handle )

Destroys the GATT handle of characteristic.

Since :: 3.0

Parameters:

[in] gatt_handle The handle of characteristic

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_characteristic_create()

int bt_gatt_characteristic_get_permissions	(	bt_gatt_h	gatt_handle,
		int *	permissions
	)

Gets the permissions which a characteristic's GATT handle has.

Since :: 3.0

Remarks:: The permissions can be one or more values of bt_gatt_permission_e, combined with bitwise 'or'.

Parameters:

[in]	gatt_handle	The handle of a characteristic
[out]	permissions	The permissions which a characteristic's GATT handle has

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_characteristic_create(); bt_gatt_permission_e

int bt_gatt_descriptor_create	(	const char *	uuid,
		int	permissions,
		const char *	value,
		int	value_length,
		bt_gatt_h *	descriptor
	)

Creates the GATT characteristic descriptor.

Since :: 3.0

Remarks:: The permissions can be one or more values of bt_gatt_permission_e, combined with bitwise 'or'.; The descriptor should be destroyed by using bt_gatt_descriptor_destroy().

Parameters:

[in]	uuid	The UUID of the descriptor
[in]	permissions	The permissions of the descriptor
[in]	value	The value(byte stream) associated with the descriptor
[in]	value_length	The length of value
[out]	descriptor	The GATT handle of the created characteristic descriptor

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_OUT_OF_MEMORY	Out of memory
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_descriptor_destroy()

int bt_gatt_descriptor_destroy ( bt_gatt_h gatt_handle )

Destroys the GATT handle of descriptor.

Since :: 3.0

Parameters:

[in] gatt_handle The handle of descriptor

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_descriptor_create()

int bt_gatt_descriptor_get_permissions	(	bt_gatt_h	gatt_handle,
		int *	permissions
	)

Gets the permissions which a descriptor's GATT handle has.

Since :: 3.0

Remarks:: The permissions can be one or more values of bt_gatt_permission_e, combined with bitwise 'or'.

Parameters:

[in]	gatt_handle	The handle of a descriptor
[out]	permissions	The permissions which a descriptor's GATT handle has

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_descriptor_create(); bt_gatt_permission_e

int bt_gatt_server_create ( bt_gatt_server_h * server )

Creates the GATT server's handle.

Since :: 3.0

Remarks:: The server handle should be destroyed by using bt_gatt_server_destroy().

Parameters:

[out] server The GATT server's handle

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_OUT_OF_MEMORY	Out of memory
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_destroy()

int bt_gatt_server_deinitialize ( void )

DeInitializes the GATT server.

Since :: 3.0

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_NOT_INITIALIZED	Not initialized
BT_ERROR_OPERATION_FAILED	Operation failed
BT_ERROR_PERMISSION_DENIED	Permission denied
BT_ERROR_NOT_SUPPORTED	Not supported

Precondition:: The state of local Bluetooth must be BT_ADAPTER_ENABLED.

See also:: bt_gatt_server_initialize()

int bt_gatt_server_destroy ( bt_gatt_server_h server )

Destroys the GATT server's handle.

Since :: 3.0

Remarks:: All registered services to GATT server are unregistered.

Parameters:

[in] server The GATT server's handle

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_create()

int bt_gatt_server_foreach_services	(	bt_gatt_server_h	server,
		bt_gatt_foreach_cb	callback,
		void *	user_data
	)

Invokes callback function on each service that belongs to the specified GATT server.

Since :: 3.0

Parameters:

[in]	server	The GATT server's handle
[in]	callback	The function to be invoked on each service
[in]	user_data	The user data to be passed to callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_foreach_cb()

int bt_gatt_server_get_service	(	bt_gatt_server_h	server,
		const char *	uuid,
		bt_gatt_h *	service
	)

Gets a service's GATT handle which has specific UUID.

Since :: 3.0

Remarks:: The returned GATT handle must not be freed by application. It will be freed when an associated server is destroyed by bt_gatt_server_destroy(). If there are multiple services which have same UUID, only the first matched one will be returned.

Parameters:

[in]	server	The GATT server's handle
[in]	uuid	The service's GATT handle which has this UUID will be returned if it exists
[out]	service	The service's GATT handle which has uuid if it exists

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NO_DATA	No data available
BT_ERROR_NOT_SUPPORTED	Not supported

int bt_gatt_server_initialize ( void )

Initializes the GATT Server.

Since :: 3.0

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_NOT_INITIALIZED	Not initialized
BT_ERROR_OPERATION_FAILED	Operation failed
BT_ERROR_PERMISSION_DENIED	Permission denied
BT_ERROR_NOT_SUPPORTED	Not supported

Precondition:: The state of local Bluetooth must be BT_ADAPTER_ENABLED.

See also:: bt_gatt_server_deinitialize()

int bt_gatt_server_notify_characteristic_changed_value	(	bt_gatt_h	characteristic,
		bt_gatt_server_notification_sent_cb	callback,
		const char *	device_address,
		void *	user_data
	)

Notifies value change of the characteristic to the remote devices which enable a Client Characteristic Configuration Descriptor.

Since :: 3.0

Parameters:

[in]	characteristic	The characteristic which has a changed value
[in]	callback	The function to be invoked on each remote device when a sending operation is done
[in]	device_address	Remote device address to send notify or indicate and if set to NULL then notify/indicate all is enabled
[in]	user_data	The user data to be passed to callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_notification_sent_cb()

int bt_gatt_server_register_service	(	bt_gatt_server_h	server,
		bt_gatt_h	service
	)

Registers a specified service to the specified GATT server that the local device is hosting.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/bluetooth

Parameters:

[in]	server	The GATT server that local device is hosting
[in]	service	The service, which needs to be registered in server

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_OPERATION_FAILED	Operation failed
BT_ERROR_ALREADY_DONE	Operation is already done
BT_ERROR_PERMISSION_DENIED	Permission denied
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_create(); bt_gatt_service_create(); bt_gatt_server_start(); bt_gatt_server_unregister_service()

int bt_gatt_server_send_response	(	int	request_id,
		bt_gatt_att_request_type_e	request_type,
		int	offset,
		int	resp_status,
		char *	value,
		int	value_length
	)

Sends a response to the remote device as a result of a read/write request.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/bluetooth

Remarks:: Until this function is called, a read/write request is not finished.

Parameters:

[in]	request_id	The identification of a read/write request
[in]	request_type	The request type for read/write
[in]	offset	The offset from where a value is read
[in]	resp_status	The application error if any occurred or BT_ERROR_NONE for successful
[in]	value	The value to be sent. It will be sent from offset. If it is NULL, a requested GATT handle's value will be sent from offset
[in]	value_length	Value Length

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_PERMISSION_DENIED	Permission denied
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_read_value_requested_cb()

int bt_gatt_server_set_characteristic_notification_state_change_cb	(	bt_gatt_h	gatt_handle,
		bt_gatt_server_characteristic_notification_state_changed_cb	callback,
		void *	user_data
	)

Registers a callback function to be invoked when the remote device enables or disables the Notification/Indication for particular characteristics.

Since :: 3.0

Parameters:

[in]	gatt_handle	The GATT handle of a characteristic
[in]	callback	The callback to be invoked
[in]	user_data	The user data to be passed to callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_characteristic_notification_state_changed_cb()

int bt_gatt_server_set_read_value_requested_cb	(	bt_gatt_h	gatt_handle,
		bt_gatt_server_read_value_requested_cb	callback,
		void *	user_data
	)

Registers a callback function to be invoked when a read request for a specified characteristic or descriptor is issued from a remote device(GATT client).

Since :: 3.0

Parameters:

[in]	gatt_handle	The GATT handle of a characteristic or descriptor
[in]	callback	The callback to be invoked
[in]	user_data	The user data to be passed to callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_read_value_requested_cb(); bt_gatt_server_send_response()

int bt_gatt_server_set_write_value_requested_cb	(	bt_gatt_h	gatt_handle,
		bt_gatt_server_write_value_requested_cb	callback,
		void *	user_data
	)

Registers a callback function to be invoked when a value of a characteristic or descriptor has been changed by a remote device(GATT client)'s request.

Since :: 3.0

Parameters:

[in]	gatt_handle	The GATT handle of a characteristic or descriptor
[in]	callback	The callback to be invoked
[in]	user_data	The user data to be passed to callback function

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_write_value_requested_cb()

int bt_gatt_server_start ( void )

Registers the application along with the GATT services of the application it is hosting.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/bluetooth

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_OPERATION_FAILED	Operation failed
BT_ERROR_ALREADY_DONE	Operation is already done
BT_ERROR_PERMISSION_DENIED	Permission denied
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_initialize(); bt_gatt_server_create(); bt_gatt_service_create(); bt_gatt_server_unregister_service()

int bt_gatt_server_unregister_all_services ( bt_gatt_server_h server )

Unregisters all services from the specified GATT server that the local device is hosting.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/bluetooth

Parameters:

[in] server The GATT server that local device is hosting

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_PERMISSION_DENIED	Permission denied
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_register_service()

int bt_gatt_server_unregister_service	(	bt_gatt_server_h	server,
		bt_gatt_h	service
	)

Unregisters a specified service from the specified GATT server that the local device is hosting.

Since :: 3.0

Privilege Level:: public

Privilege:: http://tizen.org/privilege/bluetooth

Parameters:

[in]	server	The GATT server that local device is hosting
[in]	service	The service, which needs to be unregistered from server

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_SERVICE_NOT_FOUND	Service not found
BT_ERROR_PERMISSION_DENIED	Permission denied
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_register_service()

int bt_gatt_service_add_characteristic	(	bt_gatt_h	service,
		bt_gatt_h	characteristic
	)

Adds a characteristic to a specified service.

Since :: 3.0

Parameters:

[in]	service	The service's GATT handle
[in]	characteristic	The characteristic's GATT handle to be added

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_service_create(); bt_gatt_characteristic_create()

int bt_gatt_service_add_included_service	(	bt_gatt_h	service,
		bt_gatt_h	included_service
	)

Adds a service to a specified service as included service.

Since :: 3.0

Parameters:

[in]	service	The service's GATT handle
[in]	included_service	The service's GATT handle to be added as included service

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_service_create()

int bt_gatt_service_create	(	const char *	uuid,
		bt_gatt_service_type_e	type,
		bt_gatt_h *	service
	)

Creates the GATT service.

Since :: 3.0

Remarks:: The service should be destroyed by using bt_gatt_service_destroy().

Parameters:

[in]	uuid	The UUID of the service
[in]	type	The type of the service
[out]	service	The GATT handle of the created service

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_OUT_OF_MEMORY	Out of memory
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_service_destroy()

int bt_gatt_service_destroy ( bt_gatt_h gatt_handle )

Destroys the GATT handle of service.

Since :: 3.0

Parameters:

[in] gatt_handle The handle of service

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_service_create()

int bt_gatt_service_get_server	(	bt_gatt_h	service,
		bt_gatt_server_h *	server
	)

Gets the GATT server handle to which the specified service belongs.

Since :: 3.0

Remarks:: The returned Server handle must not be freed by application.

Parameters:

[in]	service	The service's GATT handle
[out]	server	The GATT server handle to which service belongs

Returns:: 0 on success, otherwise a negative error value

Return values:

BT_ERROR_NONE	Successful
BT_ERROR_INVALID_PARAMETER	Invalid parameter
BT_ERROR_NOT_SUPPORTED	Not supported

See also:: bt_gatt_server_create(); bt_gatt_service_create(); bt_gatt_server_register_service()

Required Header

Overview

Related Features

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation