mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-02-04 06:39:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

rfcomm: improve header documentation

Browse Source
This commit is contained in:
Matthias Ringwald 2016-01-21 12:34:58 +01:00
parent 941a6c670c
commit 5fbd66f45c
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/classic/rfcomm.h
View File

@ -339,9 +339,13 @@ uint8_t rfcomm_register_service_with_initial_credits(uint8_t channel, uint16_t m
void rfcomm_unregister_service(uint8_t service_channel);
/**
* @brief Accepts/Deny incoming RFCOMM connection.
* @brief Accepts incoming RFCOMM connection.
*/
void rfcomm_accept_connection(uint16_t rfcomm_cid);
/**
* @brief Deny incoming RFCOMM connection.
*/
void rfcomm_decline_connection(uint16_t rfcomm_cid);
/**
@ -379,14 +383,25 @@ int rfcomm_send_port_configuration(uint16_t rfcomm_cid, rpn_baud_t baud_rate, rp
*/
int rfcomm_query_port_configuration(uint16_t rfcomm_cid);
/**
* @brief Query max frame size
*/
uint16_t rfcomm_get_max_frame_size(uint16_t rfcomm_cid);
/**
* @brief Allow to create RFCOMM packet in outgoing buffer.
* if (rfcomm_can_send_packet_now(cid)){
* rfcomm_reserve_packet_buffer();
* uint8_t * buffer = rfcomm_get_outgoing_buffer();
* uint16_t buffer_size = rfcomm_get_max_frame_size(cid);
* // .. setup data in buffer with len
* rfcomm_send_prepared(cid, len)
* }
*/
int rfcomm_reserve_packet_buffer(void);
void rfcomm_release_packet_buffer(void);
uint8_t * rfcomm_get_outgoing_buffer(void);
uint16_t rfcomm_get_max_frame_size(uint16_t rfcomm_cid);
int rfcomm_send_prepared(uint16_t rfcomm_cid, uint16_t len);
void rfcomm_release_packet_buffer(void);
/* API_END */
#if defined __cplusplus