btstack/docs/manual/api_pan.tex
Milanka Ringwald 1a05cc744e added apis
2015-04-09 17:11:48 +02:00

48 lines
2.2 KiB
TeX

% !TEX root = btstack_gettingstarted.tex
\section{PAN API}
\label{appendix:api_pan}
$ $
\begin{lstlisting}
/**
* @brief Creates SDP record for PANU BNEP service in provided empty buffer.
* @note Make sure the buffer is big enough.
*
* @param service is an empty buffer to store service record
* @param security_desc
* @param name if NULL, the default service name will be assigned
* @param description if NULL, the default service description will be assigned
*/
void pan_create_panu_service(uint8_t *service, const char *name, const char *description, security_description_t security_desc);
/**
* @brief Creates SDP record for GN BNEP service in provided empty buffer.
* @note Make sure the buffer is big enough.
*
* @param service is an empty buffer to store service record
* @param security_desc
* @param name if NULL, the default service name will be assigned
* @param description if NULL, the default service description will be assigned
* @param IPv4Subnet is optional subnet definition, e.g. "10.0.0.0/8"
* @param IPv6Subnet is optional subnet definition given in the standard IETF format with the absolute attribute IDs
*/
void pan_create_gn_service(uint8_t *service, const char *name, const char *description, security_description_t security_desc,
const char *IPv4Subnet, const char *IPv6Subnet);
/**
* @brief Creates SDP record for NAP BNEP service in provided empty buffer.
* @note Make sure the buffer is big enough.
*
* @param service is an empty buffer to store service record
* @param name if NULL, the default service name will be assigned
* @param security_desc
* @param description if NULL, the default service description will be assigned
* @param net_access_type type of available network access
* @param max_net_access_rate based on net_access_type measured in byte/s
* @param IPv4Subnet is optional subnet definition, e.g. "10.0.0.0/8"
* @param IPv6Subnet is optional subnet definition given in the standard IETF format with the absolute attribute IDs
*/
void pan_create_nap_service(uint8_t *service, const char *name, const char *description, security_description_t security_desc,
net_access_type_t net_access_type, uint32_t max_net_access_rate, const char *IPv4Subnet, const char *IPv6Subnet);
\end{lstlisting}
\pagebreak