gwenhywfar 5.10.1
Macros | Functions
ctf_context.c File Reference
#include "ctf_context_p.h"
#include <gwenhywfar/misc.h>
#include <gwenhywfar/debug.h>
Include dependency graph for ctf_context.c:

Go to the source code of this file.

Macros

#define DISABLE_DEBUGLOG
 

Functions

GWENHYWFAR_CB void GWEN_CTF_Context_freeData (GWEN_UNUSED void *bp, void *p)
 
GWEN_CRYPT_KEY * GWEN_CTF_Context_GetLocalAuthKey (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetLocalAuthKeyInfo (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_KEY * GWEN_CTF_Context_GetLocalCryptKey (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetLocalCryptKeyInfo (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_KEY * GWEN_CTF_Context_GetLocalSignKey (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetLocalSignKeyInfo (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_KEY * GWEN_CTF_Context_GetRemoteAuthKey (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetRemoteAuthKeyInfo (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_KEY * GWEN_CTF_Context_GetRemoteCryptKey (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetRemoteCryptKeyInfo (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_KEY * GWEN_CTF_Context_GetRemoteSignKey (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetRemoteSignKeyInfo (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_KEY * GWEN_CTF_Context_GetTempLocalSignKey (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetTempLocalSignKeyInfo (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
int GWEN_CTF_Context_IsOfThisType (const GWEN_CRYPT_TOKEN_CONTEXT *ctx)
 
GWEN_CRYPT_TOKEN_CONTEXT * GWEN_CTF_Context_new ()
 
void GWEN_CTF_Context_SetLocalAuthKey (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_KEY *k)
 
void GWEN_CTF_Context_SetLocalAuthKeyInfo (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_TOKEN_KEYINFO *ki)
 
void GWEN_CTF_Context_SetLocalCryptKey (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_KEY *k)
 
void GWEN_CTF_Context_SetLocalCryptKeyInfo (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_TOKEN_KEYINFO *ki)
 
void GWEN_CTF_Context_SetLocalSignKey (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_KEY *k)
 
void GWEN_CTF_Context_SetLocalSignKeyInfo (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_TOKEN_KEYINFO *ki)
 
void GWEN_CTF_Context_SetRemoteAuthKey (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_KEY *k)
 
void GWEN_CTF_Context_SetRemoteAuthKeyInfo (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_TOKEN_KEYINFO *ki)
 
void GWEN_CTF_Context_SetRemoteCryptKey (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_KEY *k)
 
void GWEN_CTF_Context_SetRemoteCryptKeyInfo (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_TOKEN_KEYINFO *ki)
 
void GWEN_CTF_Context_SetRemoteSignKey (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_KEY *k)
 
void GWEN_CTF_Context_SetRemoteSignKeyInfo (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_TOKEN_KEYINFO *ki)
 
void GWEN_CTF_Context_SetTempLocalSignKey (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_KEY *k)
 
void GWEN_CTF_Context_SetTempLocalSignKeyInfo (GWEN_CRYPT_TOKEN_CONTEXT *ctx, GWEN_CRYPT_TOKEN_KEYINFO *ki)
 

Macro Definition Documentation

◆ DISABLE_DEBUGLOG

#define DISABLE_DEBUGLOG

Definition at line 14 of file ctf_context.c.

Function Documentation

◆ GWEN_CTF_Context_freeData()

GWENHYWFAR_CB void GWEN_CTF_Context_freeData ( GWEN_UNUSED void *  bp,
void *  p 
)

Definition at line 54 of file ctf_context.c.

References GWEN_Crypt_Key_free(), GWEN_Crypt_Token_KeyInfo_free(), and GWEN_FREE_OBJECT.

Referenced by GWEN_CTF_Context_new().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetLocalAuthKey()

GWEN_CRYPT_KEY * GWEN_CTF_Context_GetLocalAuthKey ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 296 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GetKey(), GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenOHBCI_Encode().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetLocalAuthKeyInfo()

GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetLocalAuthKeyInfo ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 323 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__ActivateKey(), GWEN_Crypt_TokenFile__GenerateKey(), GWEN_Crypt_TokenFile__GetKeyInfo(), GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenFile__Sign().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetLocalCryptKey()

GWEN_CRYPT_KEY * GWEN_CTF_Context_GetLocalCryptKey ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 134 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GetKey(), GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenOHBCI_Encode().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetLocalCryptKeyInfo()

GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetLocalCryptKeyInfo ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 161 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GenerateKey(), GWEN_Crypt_TokenFile__GetKeyInfo(), and GWEN_Crypt_TokenFile__SetKeyInfo().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetLocalSignKey()

GWEN_CRYPT_KEY * GWEN_CTF_Context_GetLocalSignKey ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 80 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GetKey(), GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenOHBCI_Encode().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetLocalSignKeyInfo()

GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetLocalSignKeyInfo ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 107 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__ActivateKey(), GWEN_Crypt_TokenFile__GenerateKey(), GWEN_Crypt_TokenFile__GetKeyInfo(), GWEN_Crypt_TokenFile__SetKeyInfo(), GWEN_Crypt_TokenFile__Sign(), and GWEN_Crypt_TokenOHBCI_Encode().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetRemoteAuthKey()

GWEN_CRYPT_KEY * GWEN_CTF_Context_GetRemoteAuthKey ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 350 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GetKey(), GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenOHBCI_Encode().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetRemoteAuthKeyInfo()

GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetRemoteAuthKeyInfo ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 377 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GetKeyInfo(), GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenFile__Verify().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetRemoteCryptKey()

GWEN_CRYPT_KEY * GWEN_CTF_Context_GetRemoteCryptKey ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 242 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GetKey(), GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenOHBCI_Encode().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetRemoteCryptKeyInfo()

GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetRemoteCryptKeyInfo ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 269 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GetKeyInfo(), and GWEN_Crypt_TokenFile__SetKeyInfo().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetRemoteSignKey()

GWEN_CRYPT_KEY * GWEN_CTF_Context_GetRemoteSignKey ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 188 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GetKey(), GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenOHBCI_Encode().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetRemoteSignKeyInfo()

GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetRemoteSignKeyInfo ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 215 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GetKeyInfo(), GWEN_Crypt_TokenFile__SetKeyInfo(), GWEN_Crypt_TokenFile__Verify(), and GWEN_Crypt_TokenOHBCI_Encode().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetTempLocalSignKey()

GWEN_CRYPT_KEY * GWEN_CTF_Context_GetTempLocalSignKey ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 404 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__ActivateKey(), GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenOHBCI_Encode().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_GetTempLocalSignKeyInfo()

GWEN_CRYPT_TOKEN_KEYINFO * GWEN_CTF_Context_GetTempLocalSignKeyInfo ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 431 of file ctf_context.c.

References GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GenerateKey(), GWEN_Crypt_TokenFile__GetKeyInfo(), GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenOHBCI_Encode().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_IsOfThisType()

int GWEN_CTF_Context_IsOfThisType ( const GWEN_CRYPT_TOKEN_CONTEXT *  ctx)

Definition at line 45 of file ctf_context.c.

References GWEN_INHERIT_ISOFTYPE.

Referenced by GWEN_Crypt_TokenFile_AddContext().

Here is the caller graph for this function:

◆ GWEN_CTF_Context_new()

GWEN_CRYPT_TOKEN_CONTEXT * GWEN_CTF_Context_new ( )

Definition at line 30 of file ctf_context.c.

References GWEN_Crypt_Token_Context_new(), GWEN_CTF_Context_freeData(), GWEN_INHERIT_SETDATA, and GWEN_NEW_OBJECT.

Referenced by GWEN_Crypt_TokenOHBCI__Decode(), and GWEN_Crypt_TokenOHBCI_Create().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetLocalAuthKey()

void GWEN_CTF_Context_SetLocalAuthKey ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_KEY *  k 
)

Definition at line 309 of file ctf_context.c.

References GWEN_Crypt_Key_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__ActivateKey(), GWEN_Crypt_TokenFile__GenerateKey(), and GWEN_Crypt_TokenOHBCI__Decode().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetLocalAuthKeyInfo()

void GWEN_CTF_Context_SetLocalAuthKeyInfo ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_TOKEN_KEYINFO *  ki 
)

Definition at line 336 of file ctf_context.c.

References GWEN_Crypt_Token_KeyInfo_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__ActivateKey(), GWEN_Crypt_TokenFile__GenerateKey(), GWEN_Crypt_TokenOHBCI__Decode(), and GWEN_Crypt_TokenOHBCI_Create().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetLocalCryptKey()

void GWEN_CTF_Context_SetLocalCryptKey ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_KEY *  k 
)

Definition at line 147 of file ctf_context.c.

References GWEN_Crypt_Key_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GenerateKey(), and GWEN_Crypt_TokenOHBCI__Decode().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetLocalCryptKeyInfo()

void GWEN_CTF_Context_SetLocalCryptKeyInfo ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_TOKEN_KEYINFO *  ki 
)

Definition at line 174 of file ctf_context.c.

References GWEN_Crypt_Token_KeyInfo_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GenerateKey(), GWEN_Crypt_TokenOHBCI__Decode(), and GWEN_Crypt_TokenOHBCI_Create().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetLocalSignKey()

void GWEN_CTF_Context_SetLocalSignKey ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_KEY *  k 
)

Definition at line 93 of file ctf_context.c.

References GWEN_Crypt_Key_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__ActivateKey(), GWEN_Crypt_TokenFile__GenerateKey(), and GWEN_Crypt_TokenOHBCI__Decode().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetLocalSignKeyInfo()

void GWEN_CTF_Context_SetLocalSignKeyInfo ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_TOKEN_KEYINFO *  ki 
)

Definition at line 120 of file ctf_context.c.

References GWEN_Crypt_Token_KeyInfo_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__ActivateKey(), GWEN_Crypt_TokenFile__GenerateKey(), GWEN_Crypt_TokenOHBCI__Decode(), and GWEN_Crypt_TokenOHBCI_Create().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetRemoteAuthKey()

void GWEN_CTF_Context_SetRemoteAuthKey ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_KEY *  k 
)

Definition at line 363 of file ctf_context.c.

References GWEN_Crypt_Key_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenOHBCI__Decode().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetRemoteAuthKeyInfo()

void GWEN_CTF_Context_SetRemoteAuthKeyInfo ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_TOKEN_KEYINFO *  ki 
)

Definition at line 390 of file ctf_context.c.

References GWEN_Crypt_Token_KeyInfo_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenOHBCI__Decode(), and GWEN_Crypt_TokenOHBCI_Create().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetRemoteCryptKey()

void GWEN_CTF_Context_SetRemoteCryptKey ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_KEY *  k 
)

Definition at line 255 of file ctf_context.c.

References GWEN_Crypt_Key_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenOHBCI__Decode().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetRemoteCryptKeyInfo()

void GWEN_CTF_Context_SetRemoteCryptKeyInfo ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_TOKEN_KEYINFO *  ki 
)

Definition at line 282 of file ctf_context.c.

References GWEN_Crypt_Token_KeyInfo_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenOHBCI__Decode(), and GWEN_Crypt_TokenOHBCI_Create().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetRemoteSignKey()

void GWEN_CTF_Context_SetRemoteSignKey ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_KEY *  k 
)

Definition at line 201 of file ctf_context.c.

References GWEN_Crypt_Key_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__SetKeyInfo(), and GWEN_Crypt_TokenOHBCI__Decode().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetRemoteSignKeyInfo()

void GWEN_CTF_Context_SetRemoteSignKeyInfo ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_TOKEN_KEYINFO *  ki 
)

Definition at line 228 of file ctf_context.c.

References GWEN_Crypt_Token_KeyInfo_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenOHBCI__Decode(), and GWEN_Crypt_TokenOHBCI_Create().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetTempLocalSignKey()

void GWEN_CTF_Context_SetTempLocalSignKey ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_KEY *  k 
)

Definition at line 417 of file ctf_context.c.

References GWEN_Crypt_Key_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GenerateKey(), and GWEN_Crypt_TokenOHBCI__Decode().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GWEN_CTF_Context_SetTempLocalSignKeyInfo()

void GWEN_CTF_Context_SetTempLocalSignKeyInfo ( GWEN_CRYPT_TOKEN_CONTEXT *  ctx,
GWEN_CRYPT_TOKEN_KEYINFO *  ki 
)

Definition at line 444 of file ctf_context.c.

References GWEN_Crypt_Token_KeyInfo_free(), and GWEN_INHERIT_GETDATA.

Referenced by GWEN_Crypt_TokenFile__GenerateKey(), and GWEN_Crypt_TokenOHBCI__Decode().

Here is the call graph for this function:
Here is the caller graph for this function:
Generated by doxygen 1.9.5