blob: 6e9cc2ad1aabc55a8fd02c08f934281eecdbaadb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
.TH DBFP 3 2016-03-08 dbfp "DB timetable API"
.SH NAME
dbfp, dbfp_init, dbfp_close \- handle metadata for connections to the DB timetable API
.SH SYNOPSIS
.HP
.B #include <dbfp.h>
.HP
.B struct dbfp {
.RS
.B char *key;
.br
.B CURL *curl;
.RE
.B };
.HP
.B int dbfp_init(struct dbfp *dbfp, char *key);
.HP
.B void dbfp_close(struct dbfp *dbfp);
.SH DESCRIPTION
.B dbfp
stores the metadata for connections to the DB timetable API.
.B key
is the API key used for API queries.
.B curl
is the curl handle used for the API requests.
.PP
.B dbfp_init
initializes a dbfp structure with the given API key. dbfp and key may not be
NULL. dbfp must already be allocated. The key is copied to the dbfp structure.
Every structure that was initialized with this function must be closed with
dbfp_close.
.PP
.B dbfp_close
closes a dbfp structure and releases its allocated resources. dbfp itself is
not freed. If dbfp is NULL, the function returns. You should call dbfp_close
for all dbfp structures. You have to call it for all dbfp structures
initialized with dbfp_init.
.SH RETURN VALUE
.B dbfp_init
returns zero if successful, or an error code if an error occured.
.SH ERRORS
EINVAL
.RS
if one of the arguments of dbfp_init is NULL
.RE
ENOMEM
.RS
if there is not enough memory to copy the key in dbfp_init
.RE
DBFP_ERROR_CURL
.RS
if the curl handle could not be created
.RE
.SH EXAMPLE
#include <dbfp.h>
.br
#include <stdio.h>
.br
#include <string.h>
.PP
int main(int argc, char **argv)
.br
{
.RS
struct dbfp dbfp;
.br
int err;
.PP
err = dbfp_init(&dbfp, "API key");
.br
if (!err)
.RS
printf("DBFP structure created.\\n");
.RE
else
.RS
printf("Could not create DBFP: %s\\n", strerror(err));
.RE
dbfp_close(&dbfp);
.PP
return 0;
.RE
}
|
