Diffusion C API  5.9.24
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
svc-change-principal.h File Reference

Functions that allow a client to change its principal (usually, username) which is using to identify itself to Diffusion. More...

Data Structures

struct  svc_change_principal_request_s
 Structure used internally to represent the request that will be sent to Diffusion. More...
 
struct  svc_change_principal_response_s
 Structure used internally to notify the client that the request has been processed. More...
 
struct  change_principal_handlers_s
 
struct  change_principal_params_s
 Structure supplied when issuing a change_principal() request. More...
 

Macros

#define CHANGE_PRINCIPAL_HANDLERS
 Structure holding callbacks to be invoked after a request to change the principal has been sent to and processed by Diffusion.
 

Typedefs

typedef struct
svc_change_principal_request_s 
SVC_CHANGE_PRINCIPAL_REQUEST_T
 Structure used internally to represent the request that will be sent to Diffusion.
 
typedef struct
svc_change_principal_response_s 
SVC_CHANGE_PRINCIPAL_RESPONSE_T
 Structure used internally to notify the client that the request has been processed.
 
typedef int(* on_change_principal_cb )(SESSION_T *session, void *context)
 Callback indicating that a response has been received to a change principal request. More...
 
typedef struct
change_principal_params_s 
CHANGE_PRINCIPAL_PARAMS_T
 Structure supplied when issuing a change_principal() request.
 

Functions

void change_principal (SESSION_T *session, const CHANGE_PRINCIPAL_PARAMS_T params)
 Issue a request to change the principal for the current (active) session. More...
 

Detailed Description

Functions that allow a client to change its principal (usually, username) which is using to identify itself to Diffusion.

Typedef Documentation

typedef int(* on_change_principal_cb)(SESSION_T *session, void *context)

Callback indicating that a response has been received to a change principal request.

Parameters
sessionThe current active session.
contextUser-supplied context from the original change_principal() call.
Returns
HANDLER_SUCCESS or HANDLER_FAILURE.