![]() |
Datafox DFCom - API
04.03.11.00
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
|
#include "df_defines.h"
gehe zum Quellcode dieser Datei
Funktionen | |
int DF_API_CALL | DFCStartActiveConnection (const char *networkAddress, int listenPort, int deviceAddress, int timeout, int aliveTimeout, int maxConnections, int infoFlags, int unused_setTo0, int *errorNumber) |
Initalisiert und Startet das Bibiotheksmodule für den Active-Mode. Mehr ... | |
int DF_API_CALL | DFCStopActiveConnection (int *errorNumber) |
Stoppt das Bibiotheksmodule für den Active-Mode. Mehr ... | |
int DF_API_CALL | DFCGetFirstActiveConnectionId () |
Liefert die Erste Verbindungs-Id mit einer Verbindung im Active-Mode. Mehr ... | |
int DF_API_CALL | DFCGetFirstActiveChannelID () |
Liefert die Erste Verbindungs-Id mit einer Verbindung im Active-Mode. Mehr ... | |
int DF_API_CALL | DFCGetNextActiveConnectionId (int previousId) |
Liefert die Nächste Verbindungs-Id mit einer Verbindung im Active-Mode. Mehr ... | |
int DF_API_CALL | DFCGetNextActiveChannelID (int previousId) |
Liefert die Nächste Verbindungs-Id mit einer Verbindung im Active-Mode. Mehr ... | |
int DF_API_CALL | DFCGetInfoActiveChannel (int connectionId, char *value, int *valueLength) |
Liefert Informationen zu einer Verbindung im Active-Mode. Mehr ... | |
int DF_API_CALL | DFCSetRecordAvailable (int enabled) |
Liefert Informationen zu einer Verbindung im Active-Mode. Mehr ... | |
int DF_API_CALL | DFCRecordAvailable (int *connectionId, int *deviceAddress, char *infoText, int *infoTextLength, int *errorNumber) |
Liefert die nächste Verbindung im Active-Mode welche Datensätze gemeldet hat. Mehr ... | |
int DF_API_CALL | DFCBindDeviceToChannel (int connectionId, int deviceType, int deviceSerial, const char *deviceIp, int *errorNumber) |
Bindet ein Gerät im Active-Mode anhand von Gerätetyp und Seriennummer oder Geräte-Ip an eine vorgegebene Verbindungs-Id. Mehr ... | |
int DF_API_CALL DFCBindDeviceToChannel | ( | int | connectionId, |
int | deviceType, | ||
int | deviceSerial, | ||
const char * | deviceIp, | ||
int * | errorNumber | ||
) |
Bindet ein Gerät im Active-Mode anhand von Gerätetyp und Seriennummer oder Geräte-Ip an eine vorgegebene Verbindungs-Id.
Die Funktion kann vor Ausführung von DFCStartActiveConnection() oder zur Laufzeit aufgerufen werden. Durch sie können Verbindungen im Active-Mode an feste Verbindungs-Id's geknüpft werden.
Über die Funktion DFCIsChannelOpen() kann geprüft werden ob eine Verbindung besteht. Die gebundenen Verbidnungs-Id's tauchen auch bei einem Abruf mittels DFCGetFirstActiveChannelID() und DFCGetNextActiveChannelID() auf.
_DFCBindDeviceToChannel@20
DFCBindDeviceToChannel
[in] | connectionId | Zu verwendende Verbindungs-Id. Wertebereich 1 - 250. |
[in] | deviceType |
|
[in] | deviceSerial | Seriennummer des Gerätes. |
[in] | deviceIp | Ip-Adresse des zu bindenden Gerätes oder nullptr wenn eine Bindung über Gerätenummer und Seriennummer erfolgen soll. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCGetFirstActiveChannelID | ( | ) |
Liefert die Erste Verbindungs-Id mit einer Verbindung im Active-Mode.
Wurde mindesten eine Verbindung im Active-Mode entgegengenommen wird die zugeordnete Verbindung-Id geliefert. Der Wertebereich ist bei Anwendung von Mapping DFCBindDeviceToChannel() 1 - 250. Bei dynamischer Zuweisung entsprechend 251 - 391.
_DFCGetFirstActiveChannelID@0
DFCGetFirstActiveChannelID
int DF_API_CALL DFCGetFirstActiveConnectionId | ( | ) |
Liefert die Erste Verbindungs-Id mit einer Verbindung im Active-Mode.
Wurde mindesten eine Verbindung im Active-Mode entgegengenommen wird die zugeordnete Verbindung-Id geliefert. Der Wertebereich ist bei Anwendung von Mapping DFCBindDeviceToChannel() 1 - 250. Bei dynamischer Zuweisung entsprechend 251 - 391.
_DFCGetFirstActiveConnectionId@0
DFCGetFirstActiveConnectionId
int DF_API_CALL DFCGetInfoActiveChannel | ( | int | connectionId, |
char * | value, | ||
int * | valueLength | ||
) |
Liefert Informationen zu einer Verbindung im Active-Mode.
Es werden alle ermittelten und hinterlegten Werte zur Verbindung geliefert.
Beim Start des Active-Mode mit DFCStartActiveConnection() können zusätzlich zu liefernde Werte angegeben werden.
_DFCGetInfoActiveChannel@12
DFCGetInfoActiveChannel@
[in] | connectionId | Zu verwendende Verbindungs-Id. | ||||||||||||
[out] | value | Es werden immer die Information über den Verbundenen Gerätetypen und dessen Seriennummer geliefert. Zusätzlich werden die angeforderten Werte aus der Angabe bei DFCStartActiveConnection() geliefert. Alle Angaben werden mit einem \r getrennt in folgender fester Reihenfolge geliefert. Werte die nicht Ermittelt wurden, da ggf. nicht erwünscht, werden entspreched leer, jedoch nicht ausgelassen.
| ||||||||||||
[in,out] | valueLength | Als in die maximale Länge von value, als out die in value übergebene Zeichenfolge. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCGetNextActiveChannelID | ( | int | previousId | ) |
Liefert die Nächste Verbindungs-Id mit einer Verbindung im Active-Mode.
Es wird eine ggf. folgende Verbindungs-Id mit einer Verbindung im Active-Mode gesucht und zurückgeliefert. Der Wertebereich ist bei Anwendung von Mapping DFCBindDeviceToChannel() 1 - 250. Bei dynamischer Zuweisung entsprechend 251 - 391.
_DFCGetNextActiveChannelID@4
DFCGetNextActiveChannelID
int DF_API_CALL DFCGetNextActiveConnectionId | ( | int | previousId | ) |
Liefert die Nächste Verbindungs-Id mit einer Verbindung im Active-Mode.
Es wird eine ggf. folgende Verbindungs-Id mit einer Verbindung im Active-Mode gesucht und zurückgeliefert. Der Wertebereich ist bei Anwendung von Mapping DFCBindDeviceToChannel() 1 - 250. Bei dynamischer Zuweisung entsprechend 251 - 391.
_DFCGetNextActiveConnectionId@4
DFCGetNextActiveConnectionId
int DF_API_CALL DFCRecordAvailable | ( | int * | connectionId, |
int * | deviceAddress, | ||
char * | infoText, | ||
int * | infoTextLength, | ||
int * | errorNumber | ||
) |
Liefert die nächste Verbindung im Active-Mode welche Datensätze gemeldet hat.
Es werden alle ermittelten und hinterlegten Werte zur Verbindung geliefert.
Beim Start des Active-Mode mit DFCStartActiveConnection() können zusätzlich zu liefernde Werte angegeben werden.
_DFCRecordAvailable@20
DFCRecordAvailable
[out] | connectionId | Nächste Verbindungs-Id, welche Datensätze gemeldet hat. |
[out] | deviceAddress | Nächste Geräteadresse, welche Datensätze gemeldet hat. |
[out] | infoText | Diese Angabe ist die gleiche wie beim Aufruf von DFCGetInfoActiveChannel(). Siehe dort. |
[in,out] | infoTextLength | Als in die maximale Länge von infoText, als out die in infoText übergebene Zeichenfolge. |
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCSetRecordAvailable | ( | int | enabled | ) |
Liefert Informationen zu einer Verbindung im Active-Mode.
Es werden alle ermittelten und hinterlegten Werte zur Verbindung geliefert.
Beim Start des Active-Mode mit DFCStartActiveConnection() können zusätzlich zu liefernde Werte angegeben werden.
_DFCSetRecordAvailable@4
DFCSetRecordAvailable
[in] | enabled | Bei Angabe von 0 werden eingehende Datensatzmeldungen ignoriert. Vorhandene zwischengespeicherte werden entsprechend gelöscht. Bei Angabe von 1 werden eingehenden Datensatzmeldungen für den Abruf mittels DFCRecordAvailable() zwischengepsichert. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCStartActiveConnection | ( | const char * | networkAddress, |
int | listenPort, | ||
int | deviceAddress, | ||
int | timeout, | ||
int | aliveTimeout, | ||
int | maxConnections, | ||
int | infoFlags, | ||
int | unused_setTo0, | ||
int * | errorNumber | ||
) |
Initalisiert und Startet das Bibiotheksmodule für den Active-Mode.
Nach erfolgreicher Ausführung wird auf dem angegebenen Port auf eingehende Geräteverbindungen gewartet.
Bei der entgegennahme werden entsprechende Informationen ermittelt und die Verbindung über eine ggf. dynamisch vergebene Verbindungs-Id oder über ein anzugebendes Mapping (DFCBindDeviceToChannel()) zugängelich gemacht.
Die Annahme von "Datensatzmeldungen" ist standardmäßig aktiv und kann durch Aufruf von DFCSetRecordAvailable() wie gewünscht eingestellt werden.
_DFCStartActiveConnection@36
DFCStartActiveConnection
[in] | networkAddress | Adresse der Netzwerkschnittstelle von der Verbindungen entgegengenommen werden sollen. Standardwert 0.0.0.0, dieses Bedeutet es wird von allen Netzwerkschnittstellen die Verbindungen entgegengenommen. | |||||||||||||||||||||||||||
[in] | listenPort | Port auf dem die Verbindungsanfragen einlaufen müssen. Standardwert 8000. | |||||||||||||||||||||||||||
[in] | deviceAddress | Die von der Bibliothek zu verwendende Gerätenummer. Standardwert ist 0. Hierbei handelt es sich nicht um die Gerätenummer des später anzusprechenden Gerätes. Diese Angabe hier wird als Absenderadresse in den Protokollpacketen verwendet. | |||||||||||||||||||||||||||
[in] | timeout | Zu verwendender Schnittstellentimeout in Millisekunden. Standardwert 5000. | |||||||||||||||||||||||||||
[in] | aliveTimeout | Dieser Wert gibt in Sekunden an, in welchem Zyklus ein Datenpacket zwischen Gerät und Bibliothek gewechselt werden muss um sicherzustellen, dass die Verbindung noch besteht. Dieser Wert wird bei der Verbindungsentgegennahme auch an das Gerät weitergeleitet, damit dieses ebenfalls eine Verbindungsunterbrechung erkennt. | |||||||||||||||||||||||||||
[in] | maxConnections | Maximal anzunehmende Verbidnungen. Standardwert 20, Maximalwert 140. | |||||||||||||||||||||||||||
[in] | infoFlags | Es werden immer die Information über den Verbundenen Gerätetypen und dessen Seriennummer geliefert. Zusätzlich können Sie folgende Informationen anfordern. Diese werden bei der Verbindungsentgegennahme einmalig ermittelt und zwischengespeichert.
| |||||||||||||||||||||||||||
[in] | unused_setTo0 | Reserviert. Standardwert 0. | |||||||||||||||||||||||||||
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |
int DF_API_CALL DFCStopActiveConnection | ( | int * | errorNumber | ) |
Stoppt das Bibiotheksmodule für den Active-Mode.
Ggf. vorhandene Verbindungen des Active-Mode werden geschlossen. Alle gespeicherten Daten über die Verbindungen und derren aktuelle Zustände werden gelöscht.
_DFCStopActiveConnection@4
DFCStopActiveConnection
[out] | errorNumber | Fehlernummer bei fehlerhafter Ausführung. |
0 | Fehler bei Ausführung. |
1 | Ausführung war erfolgreich. |