X-Git-Url: https://git.pterodactylus.net/?p=fms.git;a=blobdiff_plain;f=include%2Ffreenet%2Ffcpv2.h;h=f83d73aa2931001cf3ab527fe8336b2f7e9849d4;hp=1f033a95eea1bfb111497d1b3d7abc3673c5e05f;hb=59a5414ec47a2932a7802fcd1d98c4d80166564f;hpb=4e96d123460d6363cf7274e36bd9357768eb86ad diff --git a/include/freenet/fcpv2.h b/include/freenet/fcpv2.h index 1f033a9..f83d73a 100644 --- a/include/freenet/fcpv2.h +++ b/include/freenet/fcpv2.h @@ -115,6 +115,8 @@ public: \brief Gets the string representing this message in FCP This string is what is actually sent/received from the node through FCP + + \return The FCP message string */ const std::string GetFCPString() const; @@ -138,13 +140,13 @@ public: /** \brief Construct connection with an existing socket - \param sock An existing socket connection to a Freenet node + \param sock An existing open socket connection to a Freenet node */ Connection(const int sock); /** - \brief Default constructor + \brief Default destructor - The deconstructor will close the connection if it is open + The destructor will close the connection if it is open */ ~Connection(); @@ -265,7 +267,7 @@ public: \brief Waits until the receive buffer contains a specified number of bytes This will continuously call Update until either the specific number of bytes have been received, - or the connection becomes disconnected + or the connection becomes disconnected. \param ms The number of milliseconds for each call to Update \param len The number of bytes to wait for