commit 8399d506304927014c55cb11d088f48b39e2579e
author Samuel Thibault <samuel.thibault@ens-lyon.org> Sun Oct 22 22:53:20 2023 +0200
committer Samuel Thibault <samuel.thibault@ens-lyon.org> Sun Oct 22 22:53:23 2023 +0200
tree ff15649d8be6d253b7c05872d790c6f9add556e1
parent 129077f9870426d1b7b3a8239d8b5a50bee017b4

Document endianness of slirp_add_hostfwd parameters

Fixes #70

src/libslirp.h

diff --git a/src/libslirp.h b/src/libslirp.h
index 09500b9..3caa6f1 100644
--- a/src/libslirp.h
+++ b/src/libslirp.h
@@ -249,7 +249,10 @@
 void slirp_handle_timer(Slirp *slirp, SlirpTimerId id, void *cb_opaque);
 
 /* These set up / remove port forwarding between a host port in the real world
- * and the guest network. */
+ * and the guest network.
+ * Note: guest_addr must be in network order, while guest_port must be in host
+ * order.
+ */
 SLIRP_EXPORT
 int slirp_add_hostfwd(Slirp *slirp, int is_udp, struct in_addr host_addr,
                       int host_port, struct in_addr guest_addr, int guest_port);