svc-authentication-register.h File Reference

Functions required for registering an authentication service in a control client. More...

Data Structures
struct	svc_authentication_register_request_s
	Structure containing the information required when sending a request to register as an authentication service. More...
struct	svc_authentication_register_response_s
	A response to an authentication registration request is considered successful by virtue of being received; there is no service-specific data returned. More...
struct	authentication_registration_handlers_s
struct	authentication_registration_params_s
	Structure supplied when issuing an authentication_register() request. More...

Macros
#define	DEFAULT_AUTH_GROUP_NAME
	If not specified, the group name "default" is used when registering authentication handlers.
#define	AUTHENTICATION_REGISTRATION_HANDLERS
	Handlers for notification of registration of an authentication handler.

Typedefs
typedef struct svc_authentication_register_request_s	SVC_AUTHENTICATION_REGISTER_REQUEST_T
	Structure containing the information required when sending a request to register as an authentication service.
typedef struct svc_authentication_register_response_s	SVC_AUTHENTICATION_REGISTER_RESPONSE_T
	A response to an authentication registration request is considered successful by virtue of being received; there is no service-specific data returned.
typedef int(*	on_authentication_registration_cb )(SESSION_T *session, void *context)
	Callback for on_registration(). More...
typedef struct authentication_registration_params_s	AUTHENTICATION_REGISTRATION_PARAMS_T
	Structure supplied when issuing an authentication_register() request.

Enumerations
enum	SESSION_DETAIL_TYPE_T { SESSION_DETAIL_SUMMARY, SESSION_DETAIL_LOCATION, SESSION_DETAIL_CONNECTOR_NAME }
	Degree of session detail required. More...

Functions
SVC_AUTHENTICATION_REGISTER_REQUEST_T *	authentication_register (SESSION_T *session, const AUTHENTICATION_REGISTRATION_PARAMS_T params)
	Register an authentication handler. More...

Detailed Description

Functions required for registering an authentication service in a control client.

Typedef Documentation

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

Callback for on_registration().

Parameters

session	The currently active session.
context	User-supplied context from the initial authentication_register() call.

Returns

HANDLER_SUCCESS or HANDLER_FAILURE.

Enumeration Type Documentation

enum SESSION_DETAIL_TYPE_T

Degree of session detail required.

When registering an authentication handler, you can request various levels of information about connecting clients to enable you to make a decision about the validity of the client. This enumeration lists the available details that can be requested.

Enumerator
SESSION_DETAIL_SUMMARY	Request summary information only.
SESSION_DETAIL_LOCATION	Also request GeoIP information.
SESSION_DETAIL_CONNECTOR_NAME	Request information about the connector which the client has used while connecting to Diffusion.