From 8ff42421c2aea33df70eb1b12d1e365736e5cee7 Mon Sep 17 00:00:00 2001 From: Stephen-Seo Date: Thu, 13 Mar 2025 08:40:44 +0000 Subject: [PATCH] deploy: ec9dbfbaa0a311ed86020fb9f847a70cd948f842 --- UDPC_8h.html | 11 ++++----- UDPC_8h_source.html | 54 ++++++++++++++++++++++----------------------- 2 files changed, 31 insertions(+), 34 deletions(-) diff --git a/UDPC_8h.html b/UDPC_8h.html index 5f0d733..0ca1b71 100644 --- a/UDPC_8h.html +++ b/UDPC_8h.html @@ -307,7 +307,7 @@ UDPC_EXPORT void UDPC_atos  Free an addr string created with UDPC_atostr_unsafe() and zeroes the pointer.
  UDPC_EXPORT int UDPC_set_heartbeat_millis (UDPC_HContext ctx, unsigned int millis) - Sets the amount of time between heartbeat packets.
+ REVERTED FUNCTION, SEE DETAILS.
  UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_strtoa (const char *addrStr) @@ -1800,12 +1800,9 @@ mode", the fastest packet sending rate is 1 packet per 0.1 seconds, or 10 packet
-

Sets the amount of time between heartbeat packets.

-

By default, UDPC sends a heartbeat packet every 150 milliseconds. This function can be used to increase the heartbeat interval time. Valid values are between 150 to 5000 milliseconds. Any value outside of this range will be clamped to within this range.

-

This function affects all connections associated with the given UDPC Context.

-

This is useful for cases where low-latency is not required. Also note that increasing the heartbeat interval may prevent UDPC from entering "good mode" for any connection. (See details for info on "good -mode" and "bad mode".)

-
Returns
0 on success, 1 if clamped to minimum, 2 if clamped to maximum, -1 if the given context is invalid.
+

REVERTED FUNCTION, SEE DETAILS.

+

This function and its provided functionality was deemed premature for production use. This function will therefore be a no-op until the feature is implemented and ready.

+
Returns
-1 always, indicating that this function does not yet work as intended.
diff --git a/UDPC_8h_source.html b/UDPC_8h_source.html index aba18dc..34afb63 100644 --- a/UDPC_8h_source.html +++ b/UDPC_8h_source.html @@ -369,33 +369,33 @@ $(function(){ initResizable(false); });
914
926UDPC_EXPORT void UDPC_atostr_unsafe_free_ptr(const char **addrBuf);
927
-
946UDPC_EXPORT int UDPC_set_heartbeat_millis(UDPC_HContext ctx, unsigned int millis);
+
938UDPC_EXPORT int UDPC_set_heartbeat_millis(UDPC_HContext ctx, unsigned int millis);
+
939
+
940// =============================================================================
+
941// Helpers
+
942
+
944UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_strtoa(const char *addrStr);
+
945
+
946UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_strtoa_link(const char *addrStr, uint32_t *linkId_out);
947
-
948// =============================================================================
-
949// Helpers
-
950
-
952UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_strtoa(const char *addrStr);
-
953
-
954UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_strtoa_link(const char *addrStr, uint32_t *linkId_out);
-
955
-
956UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_a4toa6(uint32_t a4_be);
-
957
-
958UDPC_EXPORT int UDPC_is_big_endian();
-
959
-
1000UDPC_EXPORT uint16_t UDPC_no16i(uint16_t i);
-
1001
-
1042UDPC_EXPORT uint32_t UDPC_no32i(uint32_t i);
-
1043
-
1084UDPC_EXPORT uint64_t UDPC_no64i(uint64_t i);
-
1085
-
1117UDPC_EXPORT float UDPC_no32f(float f);
-
1118
-
1150UDPC_EXPORT double UDPC_no64f(double f);
-
1151
-
1152#ifdef __cplusplus
-
1153}
-
1154#endif
-
1155#endif
+
948UDPC_EXPORT UDPC_IPV6_ADDR_TYPE UDPC_a4toa6(uint32_t a4_be);
+
949
+
950UDPC_EXPORT int UDPC_is_big_endian();
+
951
+
992UDPC_EXPORT uint16_t UDPC_no16i(uint16_t i);
+
993
+
1034UDPC_EXPORT uint32_t UDPC_no32i(uint32_t i);
+
1035
+
1076UDPC_EXPORT uint64_t UDPC_no64i(uint64_t i);
+
1077
+
1109UDPC_EXPORT float UDPC_no32f(float f);
+
1110
+
1142UDPC_EXPORT double UDPC_no64f(double f);
+
1143
+
1144#ifdef __cplusplus
+
1145}
+
1146#endif
+
1147#endif
UDPC_set_protocol_id
UDPC_EXPORT uint32_t UDPC_set_protocol_id(UDPC_HContext ctx, uint32_t id)
Sets the protocol id of the UDPC context.
UDPC_no16i
UDPC_EXPORT uint16_t UDPC_no16i(uint16_t i)
Converts a 16-bit int into/from network byte order (big endian).
UDPC_no64i
UDPC_EXPORT uint64_t UDPC_no64i(uint64_t i)
Converts a 64-bit int into/from network byte order (big endian).
@@ -461,7 +461,7 @@ $(function(){ initResizable(false); });
UDPC_PacketInfo
struct UDPC_EXPORT UDPC_PacketInfo UDPC_PacketInfo
Data representing a received/sent packet.
UDPC_ConnectionId
struct UDPC_EXPORT UDPC_ConnectionId UDPC_ConnectionId
Data identifying a peer via addr, port, and scope_id.
UDPC_create_id
UDPC_EXPORT UDPC_ConnectionId UDPC_create_id(UDPC_IPV6_ADDR_TYPE addr, uint16_t port)
Creates an UDPC_ConnectionId with the given addr and port.
-
UDPC_set_heartbeat_millis
UDPC_EXPORT int UDPC_set_heartbeat_millis(UDPC_HContext ctx, unsigned int millis)
Sets the amount of time between heartbeat packets.
+
UDPC_set_heartbeat_millis
UDPC_EXPORT int UDPC_set_heartbeat_millis(UDPC_HContext ctx, unsigned int millis)
REVERTED FUNCTION, SEE DETAILS.
UDPC_get_received
UDPC_EXPORT UDPC_PacketInfo UDPC_get_received(UDPC_HContext ctx, unsigned long *remaining)
Get a received packet from a given UDPC context.
UDPC_ConnectionId
Data identifying a peer via addr, port, and scope_id.
Definition UDPC.h:169
UDPC_Event
A struct containing information related to the type of event.
Definition UDPC.h:267
-- 2.49.0