mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-21 20:42:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

lp2p: Updated docs.

Browse Source
This commit is contained in:
yellows8 2020-10-25 19:55:33 -04:00
parent 8a31abeea7
commit 8718c145f6
No known key found for this signature in database
GPG Key ID: 0AF90DA3F1E60E43
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
nx/include/switch/services/lp2p.h
View File

@ -196,22 +196,24 @@ Result lp2pSetAdvertiseData(const void* buffer, size_t size);
/** /**
* @brief This sends an Action frame to the specified \ref Lp2pGroupId, with the specified destination \ref Lp2pMacAddress. * @brief This sends an Action frame to the specified \ref Lp2pGroupId, with the specified destination \ref Lp2pMacAddress.
* @note The role (\ref lp2pGetRole) must be non-zero. * @note The role (\ref lp2pGetRole) must be non-zero.
* @note The error from \ref lp2pGetNetworkInterfaceLastError will be returned if it's set.
* @param[in] buffer Input buffer containing arbitrary user data. * @param[in] buffer Input buffer containing arbitrary user data.
* @param[in] size Input buffer size, must be <=0x400. * @param[in] size Input buffer size, must be <=0x400.
* @param[in] addr \ref Lp2pMacAddress, this can be a broadcast address. * @param[in] addr \ref Lp2pMacAddress, this can be a broadcast address. This must be non-zero.
* @param[in] group_id \ref Lp2pGroupId * @param[in] group_id \ref Lp2pGroupId
* @param[in] frequency Must be >=1. See Lp2pGroupInfo::frequency. * @param[in] frequency Must be >=1. See Lp2pGroupInfo::frequency.
* @param[in] channel Must be >=1. See Lp2pGroupInfo::channel. * @param[in] channel Must be >=1. See Lp2pGroupInfo::channel.
* @param[in] flags This is only used for selecting which func to call internally, via bit0. * @param[in] flags Only bit0 is used: clear = block until the data can be sent, set = return error when the data can't be sent.
*/ */
Result lp2pSendToOtherGroup(const void* buffer, size_t size, Lp2pMacAddress addr, Lp2pGroupId group_id, s16 frequency, s16 channel, u32 flags); Result lp2pSendToOtherGroup(const void* buffer, size_t size, Lp2pMacAddress addr, Lp2pGroupId group_id, s16 frequency, s16 channel, u32 flags);
/** /**
* @brief This receives an Action frame. This will block until data is available (?). * @brief This receives an Action frame.
* @note The role (\ref lp2pGetRole) must be non-zero. * @note The role (\ref lp2pGetRole) must be non-zero.
* @note When data is not available, the error from \ref lp2pGetNetworkInterfaceLastError will be returned if it's set.
* @param[out] buffer Output buffer containing arbitrary user data. * @param[out] buffer Output buffer containing arbitrary user data.
* @param[in] size Output buffer size. * @param[in] size Output buffer size.
* @param[in] flags This is only used for selecting which func to call internally, via bit0. * @param[in] flags Only bit0 is used: clear = block until data is available, set = return error when data is not available.
* @param[in] addr \ref Lp2pMacAddress * @param[in] addr \ref Lp2pMacAddress
* @param[in] unk0 Unknown * @param[in] unk0 Unknown
* @param[in] unk1 Unknown * @param[in] unk1 Unknown