Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

x/crypto/ssh: Semantics of Conn.Wait and Conn.Close unclear in docs #37074

Open
darkfeline opened this issue Feb 6, 2020 · 1 comment
Open

x/crypto/ssh: Semantics of Conn.Wait and Conn.Close unclear in docs #37074

darkfeline opened this issue Feb 6, 2020 · 1 comment
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone
Unreleased

Comments

@darkfeline
Copy link
Contributor

The semantics of Conn.Wait and Conn.Close are unclear as of the docs currently.

https://pkg.go.dev/golang.org/x/crypto/ssh?tab=doc

	// Close closes the underlying network connection
	Close() error

	// Wait blocks until the connection has shut down, and returns the
	// error causing the shutdown.
	Wait() error

Is it necessary to call both, and in which order, or is just Close enough?
@gopherbot gopherbot added this to the Unreleased milestone Feb 6, 2020
@cagedmantis cagedmantis added Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Feb 6, 2020
@cagedmantis
Copy link
Contributor

/cc @hanwen @FiloSottile

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
3 participants
@cagedmantis @darkfeline @gopherbot