Public Member Functions | |
| ISaslClientContext | Client () |
| Configure this IEngineSaslDriver to operate in client mode and return the associated ISaslClientContext instance that should be used to complete the SASL negotiation with the server end. | |
| ISaslServerContext | Server () |
| Configure this IEngineSaslDriver to operate in server mode and return the associated ISaslServerContext instance that should be used to complete the SASL negotiation with the client end. | |
Properties | |
| EngineSaslState | SaslState [get] |
| Returns a SaslState that indicates the current operating state of the SASL negotiation process or conversely if no SASL layer is configured this method should return the disabled state. This method must never return a null result. | |
| SaslAuthOutcome? | SaslOutcome [get] |
| Provides a low level outcome value for the SASL authentication process. If the SASL exchange is ongoing or the SASL layer was skipped because a particular engine configuration allows such behavior then this method should return null to indicate no SASL outcome is available. | |
| uint | MaxFrameSize [get, set] |
| Provides access to the SASL drivers configured max frame size value, the max frame size can be updated before the engine has been started but is locked for updates following an engine start. | |
Member Function Documentation
◆ Client()
| ISaslClientContext Apache.Qpid.Proton.Engine.IEngineSaslDriver.Client | ( | ) |
Configure this IEngineSaslDriver to operate in client mode and return the associated ISaslClientContext instance that should be used to complete the SASL negotiation with the server end.
- Returns
- A SASL Client context instance
- Exceptions
-
InvalidOperationException If the engine is in server mode or has not been configured with SASL support.
Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineNoOpSaslDriver, and Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonEngineSaslDriver.
◆ Server()
| ISaslServerContext Apache.Qpid.Proton.Engine.IEngineSaslDriver.Server | ( | ) |
Configure this IEngineSaslDriver to operate in server mode and return the associated ISaslServerContext instance that should be used to complete the SASL negotiation with the client end.
- Returns
- A SASL Server context instance
- Exceptions
-
InvalidOperationException If the engine is in client mode or has not been configured with SASL support.
Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineNoOpSaslDriver, and Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonEngineSaslDriver.
Property Documentation
◆ MaxFrameSize
|
getset |
Provides access to the SASL drivers configured max frame size value, the max frame size can be updated before the engine has been started but is locked for updates following an engine start.
Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineNoOpSaslDriver, and Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonEngineSaslDriver.
◆ SaslOutcome
|
get |
Provides a low level outcome value for the SASL authentication process. If the SASL exchange is ongoing or the SASL layer was skipped because a particular engine configuration allows such behavior then this method should return null to indicate no SASL outcome is available.
Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineNoOpSaslDriver, and Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonEngineSaslDriver.
◆ SaslState
|
get |
Returns a SaslState that indicates the current operating state of the SASL negotiation process or conversely if no SASL layer is configured this method should return the disabled state. This method must never return a null result.
Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonEngineNoOpSaslDriver, and Apache.Qpid.Proton.Engine.Implementation.Sasl.ProtonEngineSaslDriver.
The documentation for this interface was generated from the following file:
- src/Proton/Engine/IEngineSaslDriver.cs
