add docs indicating you must call recv_stream_free and send_stream_free before endpoint_free

Author: “ramfox”

irohnet.h

@@ -838,6 +838,8 @@ recv_stream_default (void);
  *  Free the recv stream.
  *
  *  Implicitly calls `stop(0)` on the connection.
+ *
+ *  Must be called before `endpoint_free`
  */
 void
 recv_stream_free (
@@ -1016,6 +1018,8 @@ send_stream_finish (
 
 /** \brief
  *  Frees the send stream.
+ *
+ *  Must be called before `endpoint_free`
  */
 void
 send_stream_free (

main.c

@@ -457,9 +457,6 @@ run_client (
     return -1;
   }
 
-  printf("free recv_stream\n");
-  recv_stream_free(recv_stream);
-
   // indicate to the server that you want to close the connection
   printf("closing connection\n");
   connection_close(conn);
@@ -469,6 +466,9 @@ run_client (
 
   // gracefully close the endpoint. This will wait until all the connections have closed gracefully, ensure the server receives a `CONNECTION_CLOSE`, so it can also cleanly close.
 
+  printf("free recv_stream\n");
+  recv_stream_free(recv_stream);
+
   printf("closing endpoint\n");
   endpoint_close(ep);
   printf("endpoint closed\n");

src/stream.rs

@@ -22,6 +22,8 @@ pub fn recv_stream_default() -> repr_c::Box<RecvStream> {
 /// Free the recv stream.
 ///
 /// Implicitly calls `stop(0)` on the connection.
+///
+/// Must be called before `endpoint_free`
 #[ffi_export]
 pub fn recv_stream_free(stream: repr_c::Box<RecvStream>) {
     drop(stream);
@@ -161,6 +163,8 @@ pub fn send_stream_default() -> repr_c::Box<SendStream> {
 }
 
 /// Frees the send stream.
+///
+/// Must be called before `endpoint_free`
 #[ffi_export]
 pub fn send_stream_free(stream: repr_c::Box<SendStream>) {
     drop(stream);