[SslUi] Add api docs for askIgnoreSslErrors()
ClosedPublic

Authored by ahmadsamir on Oct 12 2019, 9:42 AM.

Details

Summary

This is needed as part of porting Koversation to use QSslSocket instead
of KTcpSocket.

Test Plan

The code compiles

Diff Detail

Repository
R241 KIO
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
ahmadsamir created this revision.Oct 12 2019, 9:42 AM
Restricted Application added a project: Frameworks. · View Herald TranscriptOct 12 2019, 9:42 AM
ahmadsamir requested review of this revision.Oct 12 2019, 9:42 AM

Hmm, why not just do KSslErrorUiData uiData(socket); in the caller, or even just askIgnoreSslErrors(KSslErrorUiData(socket), storedRules).
Don't know, just wondering (not objecting). @vkrause, any opinion?

src/widgets/sslui.h
40

Missing docu, at least @since 5.64

Hmm, why not just do KSslErrorUiData uiData(socket); in the caller, or even just askIgnoreSslErrors(KSslErrorUiData(socket), storedRules).
Don't know, just wondering (not objecting). @vkrause, any opinion?

My reasoning is, konversation only needs to know about SslUi::askIgnoreSslErrors and not KSslErrorUiData (implementation detail in SslUi). It's more "streamlined" for users of askIgnoreSslErrors to pass it an SSL socket rather than a KSslErrorUiData object. Anyway, I don't mind either way.

Api docs...

@since should actually be in the future

Hmm, why not just do KSslErrorUiData uiData(socket); in the caller, or even just askIgnoreSslErrors(KSslErrorUiData(socket), storedRules).
Don't know, just wondering (not objecting). @vkrause, any opinion?

That would be my gut feeling as well, ie. have sslui depend on the abstract error representation, not on all possible error sources. OTOH it's not changing the dependency situation overall here so no strong objection to that either. In any case the KTcpSocket variant should be deprecated eventually.

Hmm, why not just do KSslErrorUiData uiData(socket); in the caller, or even just askIgnoreSslErrors(KSslErrorUiData(socket), storedRules).
Don't know, just wondering (not objecting). @vkrause, any opinion?

That would be my gut feeling as well, ie. have sslui depend on the abstract error representation, not on all possible error sources. OTOH it's not changing the dependency situation overall here so no strong objection to that either. In any case the KTcpSocket variant should be deprecated eventually.

That makes more sense, (so I take what I said previously back... partly anyway; this way the implementation detail, i.e. the socket type, is hidden from SslUi so that it needs only a KSslErrorUiData).

ahmadsamir retitled this revision from [SslUi] Overload askIgnoreSslErrors() to take a QSslSocket to [SslUi] Add api docs for askIgnoreSslErrors().

Since I wrote the docs bit anyway

dfaure accepted this revision.Oct 14 2019, 7:31 AM
This revision is now accepted and ready to land.Oct 14 2019, 7:31 AM
This revision was automatically updated to reflect the committed changes.