ObjFW  Check-in [29bbfc3e47]

Overview
Comment:Minor documentation improvement
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 29bbfc3e4755cff909009e714a9d648c6d74ab0cee517e0cfd9d598a15af11a6
User & Date: js on 2023-08-25 12:25:30
Other Links: manifest | tags
Context
2023-08-25
13:20
Add reserved ivar for ABI stability on AmigaOS check-in: e3e3a88363 user: js tags: trunk
12:25
Minor documentation improvement check-in: 29bbfc3e47 user: js tags: trunk
2023-08-23
16:01
Remove incomplete NFD/NFKD support check-in: 149874777c user: js tags: trunk
Changes

Modified src/OFDatagramSocket.h from [8628474603] to [5dca355bf6].

117
118
119
120
121
122
123

124
125
126
127
128
129
130

131
132
133
134
135
136
137
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139







+







+







}

/**
 * @brief Whether the socket can block.
 *
 * By default, a socket can block.
 *
 * @throw OFGetOptionFailedException The option could not be retrieved
 * @throw OFSetOptionFailedException The option could not be set
 */
@property (nonatomic) bool canBlock;

/**
 * @brief Whether the socket can send to broadcast addresses.
 *
 * @throw OFGetOptionFailedException The option could not be retrieved
 * @throw OFSetOptionFailedException The option could not be set
 */
@property (nonatomic) bool canSendToBroadcastAddresses;

/**
 * @brief The delegate for asynchronous operations on the socket.
 *

Modified src/OFSequencedPacketSocket.h from [94c6897cee] to [3fbaff1bfd].

133
134
135
136
137
138
139

140
141
142
143
144
145
146
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147







+







}

/**
 * @brief Whether the socket can block.
 *
 * By default, a socket can block.
 *
 * @throw OFGetOptionFailedException The option could not be retrieved
 * @throw OFSetOptionFailedException The option could not be set
 */
@property (nonatomic) bool canBlock;

/**
 * @brief Whether the socket is a listening socket.
 */

Modified src/OFStream.h from [5e35ef7c78] to [99614e7bb2].

214
215
216
217
218
219
220

221
222
223
224
225
226
227
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228







+








/**
 * @brief Whether the stream can block.
 *
 * By default, a stream can block.
 * On Win32, setting this currently only works for sockets!
 *
 * @throw OFGetOptionFailedException The option could not be retrieved
 * @throw OFSetOptionFailedException The option could not be set
 */
@property (nonatomic) bool canBlock;

/**
 * @brief The delegate for asynchronous operations on the stream.
 *

Modified src/OFTCPSocket.h from [5c29465efd] to [bccc5fcf49].

80
81
82
83
84
85
86
87
88


89
90
91
92
93
94
95
96
97
98
99
100
101


102
103
104
105
106
107
108
80
81
82
83
84
85
86


87
88
89
90
91
92
93
94
95
96
97
98
99


100
101
102
103
104
105
106
107
108







-
-
+
+











-
-
+
+








#if !defined(OF_WII) && !defined(OF_NINTENDO_3DS)
/**
 * @brief Whether the socket sends keep alives for the connection.
 *
 * @warning This is not available on the Wii or Nintendo 3DS!
 *
 * @throw OFSetOptionFailedException The option could not be set
 * @throw OFGetOptionFailedException The option could not be gotten
 * @throw OFGetOptionFailedException The option could not be retrieved
 * @throw OFSetOptionFailedException The option could not be set
 */
@property (nonatomic) bool sendsKeepAlives;
#endif

#ifndef OF_WII
/**
 * @brief Whether sending segments can be delayed. Setting this to `false` sets
 *        TCP_NODELAY on the socket.
 *
 * @warning This is not available on the Wii!
 *
 * @throw OFSetOptionFailedException The option could not be set
 * @throw OFGetOptionFailedException The option could not be gotten
 * @throw OFGetOptionFailedException The option could not be retrieved
 * @throw OFSetOptionFailedException The option could not be set
 */
@property (nonatomic) bool canDelaySendingSegments;
#endif

/**
 * @brief The host to use as a SOCKS5 proxy.
 */