UaServerCallbackInterface

Typedefs
typedef OpcUa_StatusCode(*	UaServer_pfServer_SessionCreated )(UaServer_PublicSession *a_pSession)
	Callback function to inform the application that a session was created. More...
typedef OpcUa_StatusCode(*	UaServer_pfServer_SessionActivated )(UaServer_PublicSession *a_pSession)
	Callback function to inform the application that a session was activated. More...
typedef OpcUa_StatusCode(*	UaServer_pfServer_SessionClosed )(UaServer_PublicSession *a_pSession)
	Callback function to inform the application that a session was closed. More...
typedef OpcUa_StatusCode(*	UaServer_pfServer_TranslateEventField )(UaServer_PublicSession *a_pSession, UaServer_Event *a_pEvent, OpcUa_Int a_localIndex, OpcUa_Variant *a_pTarget)
	Callback function that allows the application to translate EventFields. More...
typedef OpcUa_StatusCode(*	UaServer_pfServer_AuthenticateSessionEx )(UaServer_PublicSession *a_pSession, OpcUa_ExtensionObject *a_pUserIdentityToken, OpcUa_SignatureData *a_pUserTokenSignature)
	Callback function for authenticating a session user. More...
typedef OpcUa_StatusCode(*	UaServer_pfServer_GetUserId )(OpcUa_String *a_sUsername, OpcUa_uid_t *a_pUID, OpcUa_gid_t *a_pGID)
	Callback function for getting the numeric identifier of a session user. More...
typedef OpcUa_StatusCode(*	UaServer_pfServer_GetGroupId )(OpcUa_String *a_sGroupname, OpcUa_gid_t *a_pGID)
	Callback function for getting the numeric identifier of a group. More...
typedef OpcUa_StatusCode(*	UaServer_pfServer_GetUserGroups )(OpcUa_String *a_sUsername, OpcUa_UInt16 *a_piNoGroups, OpcUa_gid_t a_pGroups[])
	Callback function for getting the list of groups to which a user belongs. More...

Detailed Description

Typedef Documentation

typedef OpcUa_StatusCode(* UaServer_pfServer_AuthenticateSessionEx)(UaServer_PublicSession *a_pSession, OpcUa_ExtensionObject *a_pUserIdentityToken, OpcUa_SignatureData *a_pUserTokenSignature)

Callback function for authenticating a session user.

This function will be called for every ActivateSession call of a client.

Parameters

[in,out]	a_pSession	The session to be activated. If authorization is enabled, the UserIdentityData member of a_pSession points to a UaServer_UserCtx structure that has to be filled by this function.
[in]	a_pUserIdentityToken	The user token passed by the client.
[in]	a_pUserTokenSignature	The user token signature passed by the client.

Returns

Return OpcUa_Good if the session user could be authenticated; return a bad status code to let the ActivateSession call fail.

typedef OpcUa_StatusCode(* UaServer_pfServer_GetGroupId)(OpcUa_String *a_sGroupname, OpcUa_gid_t *a_pGID)

Callback function for getting the numeric identifier of a group.

Parameters

[in]	a_sGroupname	The group name.
[out]	a_pGID	The numeric identifier of the group.

Returns

The status of the operation.

typedef OpcUa_StatusCode(* UaServer_pfServer_GetUserGroups)(OpcUa_String *a_sUsername, OpcUa_UInt16 *a_piNoGroups, OpcUa_gid_t a_pGroups[])

Callback function for getting the list of groups to which a user belongs.

Parameters

a_sUsername	The username.
a_piNoGroups	Number of groups.
a_pGroups	Array of group IDs.

Returns

OpcUa_Good on success, OpcUa_Bad otherwise.

typedef OpcUa_StatusCode(* UaServer_pfServer_GetUserId)(OpcUa_String *a_sUsername, OpcUa_uid_t *a_pUID, OpcUa_gid_t *a_pGID)

Callback function for getting the numeric identifier of a session user.

Parameters

[in]	a_sUsername	The user name.
[out]	a_pUID	The numeric identifier of the user.
[out]	a_pGID	The numeric identifier of the user's main group.

Returns

The status of the operation.

typedef OpcUa_StatusCode(* UaServer_pfServer_SessionActivated)(UaServer_PublicSession *a_pSession)

Callback function to inform the application that a session was activated.

Parameters

[in]

a_pSession

The session.

Returns

The return value will be ignored.

typedef OpcUa_StatusCode(* UaServer_pfServer_SessionClosed)(UaServer_PublicSession *a_pSession)

Callback function to inform the application that a session was closed.

Parameters

[in]

a_pSession

The session.

Returns

The return value will be ignored.

typedef OpcUa_StatusCode(* UaServer_pfServer_SessionCreated)(UaServer_PublicSession *a_pSession)

Callback function to inform the application that a session was created.

Parameters

[in]

a_pSession

The session.

Returns

The return value will be ignored.

typedef OpcUa_StatusCode(* UaServer_pfServer_TranslateEventField)(UaServer_PublicSession *a_pSession, UaServer_Event *a_pEvent, OpcUa_Int a_localIndex, OpcUa_Variant *a_pTarget)

Callback function that allows the application to translate EventFields.

The passed a_pEvent should not be modified, instead the translated value should be stored in a_pTarget. This function will be called for all EventFields of data type LocalizedText and ExtensionObject.

Parameters

[in]	a_pSession	The session for which the EventField shall be translated.
[in]	a_pEvent	The event containing the EventField.
[in]	a_localIndex	The local index of the EventField, can be used for getting the current value using UaServer_Events_GetEventField.
[out]	a_pTarget	The variant the translation should be written to.

Returns

The return value will be ignored.