Diffusion C API 6.12.0
Loading...
Searching...
No Matches
Authentication services.

Functions

void diffusion_set_authentication_handler (SESSION_T *session, const DIFFUSION_AUTHENTICATION_HANDLER_PARAMS_T params)
 Register an authentication handler for client authentication events.
 
bool diffusion_revoke_authentication (SESSION_T *session, const DIFFUSION_REVOKE_AUTHENTICATION_PARAMS_T params, DIFFUSION_API_ERROR *api_error)
 Revokes a session's authentication.
 

Detailed Description

Function Documentation

◆ diffusion_revoke_authentication()

bool diffusion_revoke_authentication ( SESSION_T session,
const DIFFUSION_REVOKE_AUTHENTICATION_PARAMS_T  params,
DIFFUSION_API_ERROR api_error 
)

Revokes a session's authentication.

This will immediately close the specified client session.

Parameters
sessionThe session handle. If NULL, this function returns immediately.
paramsParameters describing the diffusion_revoke_authentication request and callback handlers which may be invoked in response.
api_errorPopulated on API error. Can be NULL.
Returns
true if the operation was successful. False, otherwise. In this case, if a non-NULL api_error pointer has been provided, this will be populated with the error information and should be freed with diffusion_api_error_free.
Since
6.12

◆ diffusion_set_authentication_handler()

void diffusion_set_authentication_handler ( SESSION_T session,
const DIFFUSION_AUTHENTICATION_HANDLER_PARAMS_T  params 
)

Register an authentication handler for client authentication events.

Parameters
sessionThe session handle. If NULL, this function returns immediately with the value NULL.
paramsParameters defining the request to register an authentication handler.