message.h File Reference

#include <gwenhywfar/misc.h>
#include <aqhbci/dialog.h>
#include <gwenhywfar/xml.h>
#include <stdio.h>

Go to the source code of this file.

Debugging Functions

#define AH_Msg_Dump(hmsg, f, indent)
void AH_Msg__Dump (const AH_MSG *hmsg, FILE *f, unsigned int indent)

Constructor And Destructor

AH_MSG * AH_Msg_new (AH_DIALOG *dlg)
void AH_Msg_free (AH_MSG *hmsg)

Cryptographic Stuff

GWEN_KEYSPEC * AH_Msg_GetSigners (const AH_MSG *hmsg)
int AH_Msg_AddSigner (AH_MSG *hmsg, const GWEN_KEYSPEC *ks)
unsigned int AH_Msg_GetSignerCount (AH_MSG *hmsg)
int AH_Msg_IsSignedBy (const AH_MSG *hmsg, const char *s)
const GWEN_KEYSPEC * AH_Msg_GetCrypter (const AH_MSG *hmsg)
void AH_Msg_SetCrypter (AH_MSG *hmsg, const GWEN_KEYSPEC *ks)

Informational Functions

GWEN_BUFFER * AH_Msg_GetBuffer (AH_MSG *hmsg)
GWEN_BUFFER * AH_Msg_TakeBuffer (AH_MSG *hmsg)
void AH_Msg_SetBuffer (AH_MSG *hmsg, GWEN_BUFFER *bf)
unsigned int AH_Msg_GetMsgNum (const AH_MSG *hmsg)
unsigned int AH_Msg_GetMsgRef (const AH_MSG *hmsg)
void AH_Msg_SetMsgRef (AH_MSG *hmsg, unsigned int i)
unsigned int AH_Msg_GetNodes (AH_MSG *hmsg)
AH_DIALOG * AH_Msg_GetDialog (const AH_MSG *hmsg)
int AH_Msg_EnableInsert (AH_MSG *hmsg)
int AH_Msg_HasWarnings (const AH_MSG *hmsg)
void AH_Msg_SetHasWarnings (AH_MSG *hmsg, int i)
int AH_Msg_HasErrors (const AH_MSG *hmsg)
void AH_Msg_SetHasErrors (AH_MSG *hmsg, int i)
int AH_Msg_GetResultCode (const AH_MSG *hmsg)
void AH_Msg_SetResultCode (AH_MSG *hmsg, int i)
const char * AH_Msg_GetResultText (const AH_MSG *hmsg)
void AH_Msg_SetResultText (AH_MSG *hmsg, const char *s)
const char * AH_Msg_GetResultParam (const AH_MSG *hmsg)
void AH_Msg_SetResultParam (AH_MSG *hmsg, const char *s)
unsigned int AH_Msg_GetHbciVersion (const AH_MSG *hmsg)
void AH_Msg_SetHbciVersion (AH_MSG *hmsg, unsigned int i)
const char * AH_Msg_GetTan (const AH_MSG *hmsg)
int AH_Msg_GetNeedTan (const AH_MSG *hmsg)
void AH_Msg_SetNeedTan (AH_MSG *hmsg, int i)
int AH_Msg_NoSysId (const AH_MSG *hmsg)
void AH_Msg_SetNoSysId (AH_MSG *hmsg, int i)

Encoding, Decoding And Completing a Message

unsigned int AH_Msg_GetCurrentSegmentNumber (AH_MSG *hmsg)
unsigned int AH_Msg_AddNode (AH_MSG *hmsg, GWEN_XMLNODE *node, GWEN_DB_NODE *data)
unsigned int AH_Msg_InsertNode (AH_MSG *hmsg, GWEN_XMLNODE *node, GWEN_DB_NODE *data)
int AH_Msg_EncodeMsg (AH_MSG *hmsg)
int AH_Msg_DecodeMsg (AH_MSG *hmsg, GWEN_DB_NODE *gr, unsigned int flags)
void AH_Msg_SetDecodedMsg (AH_MSG *msg, GWEN_DB_NODE *db)
GWEN_DB_NODE * AH_Msg_GetDecodedMsg (const AH_MSG *msg)
GWEN_DB_NODE * AH_Msg_TakeDecodedMsg (AH_MSG *msg)

Typedefs

typedef AH_MSG AH_MSG

Functions

 GWEN_LIST_FUNCTION_DEFS (AH_MSG, AH_Msg)

Define Documentation

#define AH_Msg_Dump (  hmsg,
f,
indent   ) 
 

Value:

{fprintf(stderr, "Dumping message from "__FILE__" %d\n", __LINE__);\
  AH_Msg__Dump(hmsg, f, indent);}

Definition at line 176 of file message.h.

Typedef Documentation

typedef struct AH_MSG AH_MSG
 

Definition at line 19 of file message.h.

Function Documentation

void AH_Msg__Dump (  const AH_MSG *  hmsg,
FILE *  f,
unsigned int  indent
) 
 

unsigned int AH_Msg_AddNode (  AH_MSG *  hmsg,
GWEN_XMLNODE *  node,
GWEN_DB_NODE *  data
) 
 

int AH_Msg_AddSigner (  AH_MSG *  hmsg,
const GWEN_KEYSPEC *  ks
) 
 

int AH_Msg_DecodeMsg (  AH_MSG *  hmsg,
GWEN_DB_NODE *  gr,
unsigned int  flags
) 
 

Parameters:
flags flags for GWEN_MsgEngine_ParseMessage

int AH_Msg_EnableInsert (  AH_MSG *  hmsg  ) 
 

int AH_Msg_EncodeMsg (  AH_MSG *  hmsg  ) 
 

void AH_Msg_free (  AH_MSG *  hmsg  ) 
 

GWEN_BUFFER* AH_Msg_GetBuffer (  AH_MSG *  hmsg  ) 
 

const GWEN_KEYSPEC* AH_Msg_GetCrypter (  const AH_MSG *  hmsg  ) 
 

unsigned int AH_Msg_GetCurrentSegmentNumber (  AH_MSG *  hmsg  ) 
 

GWEN_DB_NODE* AH_Msg_GetDecodedMsg (  const AH_MSG *  msg  ) 
 

Returns the DB which resulted from decoding the message. This DB must have been stored before (it is not automatically stored upon decoding to avois copying). The message remains owner of the DB returned.

AH_DIALOG* AH_Msg_GetDialog (  const AH_MSG *  hmsg  ) 
 

unsigned int AH_Msg_GetHbciVersion (  const AH_MSG *  hmsg  ) 
 

unsigned int AH_Msg_GetMsgNum (  const AH_MSG *  hmsg  ) 
 

unsigned int AH_Msg_GetMsgRef (  const AH_MSG *  hmsg  ) 
 

int AH_Msg_GetNeedTan (  const AH_MSG *  hmsg  ) 
 

unsigned int AH_Msg_GetNodes (  AH_MSG *  hmsg  ) 
 

int AH_Msg_GetResultCode (  const AH_MSG *  hmsg  ) 
 

const char* AH_Msg_GetResultParam (  const AH_MSG *  hmsg  ) 
 

const char* AH_Msg_GetResultText (  const AH_MSG *  hmsg  ) 
 

unsigned int AH_Msg_GetSignerCount (  AH_MSG *  hmsg  ) 
 

GWEN_KEYSPEC* AH_Msg_GetSigners (  const AH_MSG *  hmsg  ) 
 

const char* AH_Msg_GetTan (  const AH_MSG *  hmsg  ) 
 

int AH_Msg_HasErrors (  const AH_MSG *  hmsg  ) 
 

int AH_Msg_HasWarnings (  const AH_MSG *  hmsg  ) 
 

unsigned int AH_Msg_InsertNode (  AH_MSG *  hmsg,
GWEN_XMLNODE *  node,
GWEN_DB_NODE *  data
) 
 

int AH_Msg_IsSignedBy (  const AH_MSG *  hmsg,
const char *  s
) 
 

AH_MSG* AH_Msg_new (  AH_DIALOG *  dlg  ) 
 

int AH_Msg_NoSysId (  const AH_MSG *  hmsg  ) 
 

void AH_Msg_SetBuffer (  AH_MSG *  hmsg,
GWEN_BUFFER *  bf
) 
 

void AH_Msg_SetCrypter (  AH_MSG *  hmsg,
const GWEN_KEYSPEC *  ks
) 
 

void AH_Msg_SetDecodedMsg (  AH_MSG *  msg,
GWEN_DB_NODE *  db
) 
 

When encoding a message the resulting DB is not stored automatically inside the message object (to avoid copying). You can use this function to do it. Id a message contains signatures it is important that the message is only decoded once. The second time you try to decode such a message would lead to an error ("double use of signature detected"). So we need a place to store the result when storing the message inside the list of unrequested messages (see AH_HBCIClient_AddUnrequestedMsg), since we only can determine whether a message is requested if we decode it. This function takes over ownership of the DB object.

void AH_Msg_SetHasErrors (  AH_MSG *  hmsg,
int  i
) 
 

void AH_Msg_SetHasWarnings (  AH_MSG *  hmsg,
int  i
) 
 

void AH_Msg_SetHbciVersion (  AH_MSG *  hmsg,
unsigned int  i
) 
 

void AH_Msg_SetMsgRef (  AH_MSG *  hmsg,
unsigned int  i
) 
 

void AH_Msg_SetNeedTan (  AH_MSG *  hmsg,
int  i
) 
 

void AH_Msg_SetNoSysId (  AH_MSG *  hmsg,
int  i
) 
 

void AH_Msg_SetResultCode (  AH_MSG *  hmsg,
int  i
) 
 

void AH_Msg_SetResultParam (  AH_MSG *  hmsg,
const char *  s
) 
 

void AH_Msg_SetResultText (  AH_MSG *  hmsg,
const char *  s
) 
 

GWEN_BUFFER* AH_Msg_TakeBuffer (  AH_MSG *  hmsg  ) 
 

GWEN_DB_NODE* AH_Msg_TakeDecodedMsg (  AH_MSG *  msg  ) 
 

Returns the DB which resulted from decoding the message. This DB must have been stored before (it is not automatically stored upon decoding to avois copying). This function relinquishes the ownership of the DB to the caller.

GWEN_LIST_FUNCTION_DEFS (  AH_MSG  ,
AH_Msg 
) 
 

Generated on Sat Jan 7 04:22:42 2006 for aqbanking by  doxygen 1.4.6