Description

Defines Enterprise Security class with methods to join/leave an enterprise network.

Inheritance diagram for EnterpriseSecurity:

Public Member Functions
	EnterpriseSecurity (cy_enterprise_security_parameters_t *ent_parameters)
	EnterpriseSecurity constructor. More...

	~EnterpriseSecurity ()
	EnterpriseSecurity destructor.

cy_rslt_t	join (void)
	Joins an enterprise security network (802.1x Access point) More...

cy_rslt_t	leave (void)
	Leaves an Enterprise security network (802.1x Access point) More...

Constructor & Destructor Documentation

◆ EnterpriseSecurity()

EnterpriseSecurity::EnterpriseSecurity ( cy_enterprise_security_parameters_t * ent_parameters )

EnterpriseSecurity constructor.

Parameters

[in] ent_parameters : Pointer to cy_enterprise_security_parameters_t structure, initialized by the caller with the details required for establishing connection with the enterprise network.

Member Function Documentation

◆ join()

cy_rslt_t EnterpriseSecurity::join ( void )

Joins an enterprise security network (802.1x Access point)

Returns: cy_rslt_t : CY_RSLT_SUCCESS - on success, an error code otherwise. Error codes returned by this function are:
CY_RSLT_ENTERPRISE_SECURITY_BADARG
CY_RSLT_ENTERPRISE_SECURITY_ALREADY_CONNECTED
CY_RSLT_ENTERPRISE_SECURITY_NOMEM
CY_RSLT_ENTERPRISE_SECURITY_JOIN_ERROR
CY_RSLT_ENTERPRISE_SECURITY_SUPPLICANT_ERROR

◆ leave()

cy_rslt_t EnterpriseSecurity::leave ( void )

Leaves an Enterprise security network (802.1x Access point)