documentation

include/aws/io/private/tls_channel_handler_shared.h

@@ -25,6 +25,12 @@ enum aws_tls_handler_read_state {
     AWS_TLS_HANDLER_READ_SHUT_DOWN_COMPLETE,
 };
 
+/* Apple Network socket connections when using secitem handles both the TCP and TLS
+ * handshakes with a singular completion state change/callback.
+ * Various TLS related elements must be accessible during the socket creation
+ * and listener binding to fit within the framework around TCP, TLS, and ALPN.
+ * This struct is used as a container that can retrieve the necessary elements when
+ * they are needed. */
 struct tls_connection_context {
     struct aws_string *host_name;
     struct aws_string *alpn_list;

include/aws/io/socket.h

@@ -76,8 +76,8 @@ typedef void(aws_socket_on_connection_result_fn)(struct aws_socket *socket, int
 struct aws_tls_connection_options;
 
 /**
- * Called to retrieve TLS related options during socket creation/initialization. Typically the TLS
- * handshake occurs after a socket connection is established but Apple Network Framework requires
+ * Called to retrieve TLS related options during socket creation/initialization and socket listener binding.
+ * Typically the TLS handshake occurs after a socket connection is established but Apple Network Framework requires
  * the setup of TLS related parameters at creation of the connection as its internal framework
  * handles both the socket connection and the TLS handshake.
  */