Skip to content

Commit

Permalink
adjust comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ekovacs committed Aug 29, 2024
1 parent 6e397ee commit f4d6fe9
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions acceptor.go
Original file line number Diff line number Diff line change
Expand Up @@ -426,11 +426,12 @@ func (a *Acceptor) SetConnectionValidator(validator ConnectionValidator) {
a.connectionValidator = validator
}

// SetTLSConfig allows the creator of the Acceptor to specify a fully customizable tls.Config.

// When the caller explicitly provides a tls.Config with this function,
// SetTLSConfig allows the creator of the Acceptor to specify a fully customizable tls.Config of their choice,
// which will be used in the Start() method.
//
// Note: when the caller explicitly provides a tls.Config with this function,
// it takes precendent over TLS settings specified in the acceptor's settings.GlobalSettings(),
// meaning that the setting object is not inspected or used for the creation of the tls.Config.
// meaning that the `settings.GlobalSettings()` object is not inspected or used for the creation of the tls.Config.
func (a *Acceptor) SetTLSConfig(tlsConfig *tls.Config) {
a.tlsConfig = tlsConfig
}

0 comments on commit f4d6fe9

Please sign in to comment.