ObjFW  Changes To API Review for 1.0

Changes to "API Review for 1.0" between 2022-04-19 16:49:17 and 2022-04-19 16:53:20

1
2
3
4
5
6
7
8
9


10
11
12
13
14
15
16
1
2
3
4
5
6
7


8
9
10
11
12
13
14
15
16







-
-
+
+







# API Review for 1.0

For the 1.0 release, all APIs should be reviewed, as starting with 1.0, they are supposed to be stable. All documented methods, functions, classes, types and structs that are part of the installed headers are considered part of the API.

Right now, we have fhe following installed headers:

* ❌ `ObjFW/macros.h`
*  `ObjFW/objfw-defs.h`
*  `ObjFW/ObjFW.h`
*  `ObjFW/objfw-defs.h`
*  `ObjFW/ObjFW.h`
* ❌ `ObjFW/OFAcceptFailedException.h`
* ❌ `ObjFW/OFAllocFailedException.h`
* ❌ `ObjFW/OFAlreadyConnectedException.h`
* ❌ `ObjFW/OFApplication.h`
* ❌ `ObjFW/OFArray.h`
* ❌ `ObjFW/OFAtomic.h`
* ❌ `ObjFW/OFBindFailedException.h`
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
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







-
+
















-
-
+
+







* ❌ `ObjFW/OFDictionary.h`
* ❌ `ObjFW/OFDNSQueryFailedException.h`
* ❌ `ObjFW/OFDNSQuery.h`
* ❌ `ObjFW/OFDNSResolver.h`
* ❌ `ObjFW/OFDNSResourceRecord.h`
* ❌ `ObjFW/OFDNSResponse.h`
* ❌ `ObjFW/OFEnumerationMutationException.h`
*  `ObjFW/OFEnumerator.h`
*  `ObjFW/OFEnumerator.h`
* ❌ `ObjFW/OFException.h`
* ❌ `ObjFW/OFFile.h`
* ❌ `ObjFW/OFFileManager.h`
* ❌ `ObjFW/OFGetCurrentDirectoryPathFailedException.h`
* ❌ `ObjFW/OFGetOptionFailedException.h`
* ❌ `ObjFW/OFGZIPStream.h`
* ❌ `ObjFW/OFHashAlreadyCalculatedException.h`
* ❌ `ObjFW/OFHashNotCalculatedException.h`
* ❌ `ObjFW/OFHMAC.h`
* ❌ `ObjFW/OFHTTPClient.h`
* ❌ `ObjFW/OFHTTPCookie.h`
* ❌ `ObjFW/OFHTTPCookieManager.h`
* ❌ `ObjFW/OFHTTPRequestFailedException.h`
* ❌ `ObjFW/OFHTTPRequest.h`
* ❌ `ObjFW/OFHTTPResponse.h`
* ❌ `ObjFW/OFHTTPServer.h`
*  `ObjFW/OFInflate64Stream.h`
*  `ObjFW/OFInflateStream.h`
*  `ObjFW/OFInflate64Stream.h`
*  `ObjFW/OFInflateStream.h`
* ❌ `ObjFW/OFINICategory.h`
* ❌ `ObjFW/OFINIFile.h`
* ❌ `ObjFW/OFInitializationFailedException.h`
* ❌ `ObjFW/OFInvalidArgumentException.h`
* ❌ `ObjFW/OFInvalidEncodingException.h`
* ❌ `ObjFW/OFInvalidFormatException.h`
* ❌ `ObjFW/OFInvalidJSONException.h`
129
130
131
132
133
134
135
136

137
138
139
140
141
142
143
129
130
131
132
133
134
135

136
137
138
139
140
141
142
143







-
+







* ❌ `ObjFW/OFReadFailedException.h`
* ❌ `ObjFW/OFReadOrWriteFailedException.h`
* ✅ `ObjFW/OFRecursiveMutex.h`
* ❌ `ObjFW/OFRemoveItemFailedException.h`
* ❌ `ObjFW/OFResolveHostFailedException.h`
* ❌ `ObjFW/OFRetrieveItemAttributesFailedException.h`
* ❌ `ObjFW/OFRIPEMD160Hash.h`
*  `ObjFW/OFRunLoop.h`
*  `ObjFW/OFRunLoop.h`
* ❌ `ObjFW/OFScrypt.h`
* ❌ `ObjFW/OFSecureData.h`
* ❌ `ObjFW/OFSeekableStream.h`
* ❌ `ObjFW/OFSeekFailedException.h`
* ❌ `ObjFW/OFSequencedPacketSocket.h`
* ❌ `ObjFW/OFSerialization.h`
* ❌ `ObjFW/OFSet.h`