ERiC API-Referenz 43.3.2.0

Lade ...
Suche ...
Keine Treffer
Datenstrukturen | Typdefinitionen | Aufzählungen
otto_types.h-Dateireferenz

Definition von Datenstrukturen und Datentypen. Mehr ...

Dieser Graph zeigt, welche Datei direkt oder indirekt diese Datei enthält:

gehe zum Quellcode dieser Datei

## Datenstrukturen
struct | OttoProxyKonfiguration
| Diese Struktur enthält alle Informationen, die Otto benötigt, um die Verbindung zum OTTER-Server oder dem ELSTER-eID-Server über einen Proxy aufzubauen. Mehr ...

## Typdefinitionen
typedef struct OttoInstanz * | OttoInstanzHandle
| Handle auf eine Otto-Instanz.
typedef struct OttoZertifikat * | OttoZertifikatHandle
| Handle auf ein Sicherheitstoken zur Authentifizierung des Daten-Übermittlers oder -Abholers.
typedef struct OttoRueckgabepuffer * | OttoRueckgabepufferHandle
| Handle auf einen Otto-Rückgabepuffer.
typedef struct OttoPruefsumme * | OttoPruefsummeHandle
| Handle auf eine Otto-Prüfsumme.
typedef struct OttoVersand * | OttoVersandHandle
| Handle auf ein Otto-Versandobjekt.
typedef struct OttoEmpfang * | OttoEmpfangHandle
| Handle auf ein Otto-Empfangsobjekt.
typedef int(* | OttoLogCallback) (const char *instanzId, const char *logZeitpunkt, OttoLogEbene logEbene, const char *logNachricht, void *benutzerdaten)
| Funktionstyp für einen Log-Callback, den eine Anwendung beim Erzeugen einer Otto-Instanz angeben kann.

## Aufzählungen
enum | OttoLogEbene { OTTOLOG_FEHLERMELDUNGEN = 4 , OTTOLOG_WARNUNGEN = 3 , OTTOLOG_INFORMATIONEN = 2 , OTTOLOG_DEBUGMELDUNGEN = 1 }
| Aufzählung der Log-Ebenen von Otto. Mehr ...

## Ausführliche Beschreibung

Definition von Datenstrukturen und Datentypen.

Definiert in Datei otto_types.h.

## Dokumentation der benutzerdefinierten Typen

## ◆ OttoEmpfangHandle

typedef struct OttoEmpfang* OttoEmpfangHandle

Handle auf ein Otto-Empfangsobjekt.

Über ein Empfangsobjekt können Daten blockweise vom OTTER-Server heruntergeladen werden.

Definiert in Zeile 82 der Datei otto_types.h.

## ◆ OttoInstanzHandle

typedef struct OttoInstanz* OttoInstanzHandle

Handle auf eine Otto-Instanz.

Jede Funktion der Otto-API ist direkt oder indirekt an eine Otto-Instanz gebunden. Die Otto-Instanz enthält sämtliche veränderlichen Zustände von Otto.

Es können mehrere Instanzen gleichzeitig existieren. Jede der Instanzen ist unabhängig von allen anderen. Verfügen mehrere Threads über jeweils ihre eigene Otto-Instanz, können sie diese Instanzen parallel verwenden.

Eine Otto-Instanz kann zwischen Threads ausgetauscht werden. Sie darf aber nicht in zwei Threads gleichzeitig verwendet werden.

Siehe auch
  - OttoInstanzErzeugen()
  - OttoInstanzFreigeben()

Definiert in Zeile 28 der Datei otto_types.h.

## ◆ OttoLogCallback

typedef int(* OttoLogCallback) (const char *instanzId, const char *logZeitpunkt, OttoLogEbene logEbene, const char *logNachricht, void *benutzerdaten)

Funktionstyp für einen Log-Callback, den eine Anwendung beim Erzeugen einer Otto-Instanz angeben kann.

Rückgabe
  - 0 wenn die Log-Meldung erfolgreich entgegengenommen werden konnte, ungleich 0 im Fehlerfall. Momentan wird der Rückgabewert vom Otto jedoch ignoriert.

Definiert in Zeile 126 der Datei otto_types.h.

## ◆ OttoPruefsummeHandle

typedef struct OttoPruefsumme* OttoPruefsummeHandle

Handle auf eine Otto-Prüfsumme.

Um die Datenintegrität sicherzustellen, ist beim Versand von Daten an den OTTER-Server eine Prüfsumme über die Daten zu übermitteln.

Diese Prüfsumme ist schon beim Verbindungsaufbau an die Server zu übermitteln und kann daher nicht während der Datenübertragung implizit gebildet werden, sondern muss vorab explizit berechnet werden.

Definiert in Zeile 66 der Datei otto_types.h.

## ◆ OttoRueckgabepufferHandle

typedef struct OttoRueckgabepuffer* OttoRueckgabepufferHandle

Handle auf einen Otto-Rückgabepuffer.

Ein Otto-Rückgabepuffer dient zur Übergabe von Daten vom Otto an die Anwendung. Die Anwendung erstellt dazu einen Otto-Rückgabepuffer und übergibt dessen Handle als Parameter einer API-Funktion an den Otto. Der Otto befüllt den Otto-Rückgabepuffer dann mit Daten.

Zu beachten
  Eventuell bereits im Otto-Rückgabepuffer befindliche Daten werden beim Aufruf von API-Funktionen gelöscht. Ausgenommen davon sind natürlich die API-Funktionen mit dem Präfix "OttoRueckgabepuffer", die einen Otto-Rückgabepuffer selbst behandeln.

Siehe auch
  - OttoRueckgabepufferErzeugen()
  - OttoRueckgabepufferFreigeben()
  - OttoRueckgabepufferInhalt()
  - OttoRueckgabepufferGroesse()

Definiert in Zeile 54 der Datei otto_types.h.

## ◆ OttoVersandHandle

typedef struct OttoVersand* OttoVersandHandle

Handle auf ein Otto-Versandobjekt.

Über ein Versandobjekt können Daten blockweise an die OTTER-Server übermittelt werden.

Definiert in Zeile 74 der Datei otto_types.h.

## ◆ OttoZertifikatHandle

typedef struct OttoZertifikat* OttoZertifikatHandle

Handle auf ein Sicherheitstoken zur Authentifizierung des Daten-Übermittlers oder -Abholers.

Definiert in Zeile 34 der Datei otto_types.h.

## Dokumentation der Aufzählungstypen

## ◆ OttoLogEbene

enum OttoLogEbene

Aufzählung der Log-Ebenen von Otto.

Die Log-Meldungen von Otto sind in Ebenen angeordnet: von der höchsten Ebene mit den wichtigsten Fehlermeldungen bis hin zu niedrigsten Ebene mit einfachen Meldungen, die nur bei der Suche nach Fehlerursachen interessant sind.

Standardmäßig werden nur Meldungen der beiden höchsten Ebenen (Fehler und Warnungen) protokolliert.

Sollen auch Meldungen der niedrigeren Ebenen protokolliert werden, so kann über die Funktion OttoInstanzErzeugen() ein Callback vom Typ OttoLogCallback registriert werden, in dem die Meldungen nach der Ebene gefiltert werden können.

Siehe auch
  - OttoInstanzErzeugen()

Aufzählungswerte
OTTOLOG_FEHLERMELDUNGEN | Fehler, die zum Abbruch der gewünschten Aktion führen.
OTTOLOG_WARNUNGEN | Hinweise auf Zustände, die zu Fehlern führen können.
OTTOLOG_INFORMATIONEN | Grobe Informationen über den Programmablauf und Werte.
OTTOLOG_DEBUGMELDUNGEN | Feingranulare Informationen über den Programmablauf und Werte.

Definiert in Zeile 103 der Datei otto_types.h.