Skip to content

Commit

Permalink
docs(socket): req socket comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonas Bostoen authored and mempirate committed Jan 19, 2024
1 parent b5c3423 commit 4c66e47
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion msg-socket/src/req/socket.rs
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ where
response_rx.await.map_err(|_| ReqError::SocketClosed)?
}

/// Connects to the target with the default options. WARN: this will block until the connection can be established.
/// Connects to the target with the default options. WARN: this will wait until the connection can be established.
pub async fn connect(&mut self, endpoint: SocketAddr) -> Result<(), ReqError> {
// Initialize communication channels
let (to_driver, from_socket) = mpsc::channel(DEFAULT_BUFFER_SIZE);
Expand Down

0 comments on commit 4c66e47

Please sign in to comment.