Skip to content

Commit

Permalink
improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xiazhvera committed Dec 3, 2024
1 parent d784f96 commit d880859
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -755,8 +755,7 @@ Shuts down any pending operations on the socket, and cleans up state. The socket

int aws_socket_connect(struct aws_socket *socket, struct aws_socket_endpoint *remote_endpoint);

Connects to a remote endpoint. In TCP and all Apple Network Framework connections (regardless it is UDP, TCP or LOCAL), this will
function will not block. If the return value is successful, then you must wait on the `on_connection_established()` callback to
Connects to a remote endpoint. In TCP and all Apple Network Framework connections (regardless it is UDP, TCP or LOCAL), when the connection succeed, you still must wait on the `on_connection_established()` callback to
be invoked before using the socket.

In UDP, this simply binds the socket to a remote address for use with `aws_socket_write()`, and if the operation is successful,
Expand Down

0 comments on commit d880859

Please sign in to comment.