czmq-ffi-gen 0.13.0 → 0.14.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (34) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +8 -0
  3. data/lib/czmq-ffi-gen/czmq/ffi/zactor.rb +40 -7
  4. data/lib/czmq-ffi-gen/czmq/ffi/zargs.rb +259 -0
  5. data/lib/czmq-ffi-gen/czmq/ffi/zarmour.rb +3 -3
  6. data/lib/czmq-ffi-gen/czmq/ffi/zcert.rb +15 -6
  7. data/lib/czmq-ffi-gen/czmq/ffi/zcertstore.rb +25 -11
  8. data/lib/czmq-ffi-gen/czmq/ffi/zchunk.rb +18 -18
  9. data/lib/czmq-ffi-gen/czmq/ffi/zclock.rb +6 -6
  10. data/lib/czmq-ffi-gen/czmq/ffi/zconfig.rb +27 -17
  11. data/lib/czmq-ffi-gen/czmq/ffi/zdigest.rb +4 -4
  12. data/lib/czmq-ffi-gen/czmq/ffi/zdir.rb +36 -36
  13. data/lib/czmq-ffi-gen/czmq/ffi/zdir_patch.rb +1 -1
  14. data/lib/czmq-ffi-gen/czmq/ffi/zfile.rb +27 -19
  15. data/lib/czmq-ffi-gen/czmq/ffi/zframe.rb +22 -21
  16. data/lib/czmq-ffi-gen/czmq/ffi/zhash.rb +54 -54
  17. data/lib/czmq-ffi-gen/czmq/ffi/zhashx.rb +82 -80
  18. data/lib/czmq-ffi-gen/czmq/ffi/ziflist.rb +30 -0
  19. data/lib/czmq-ffi-gen/czmq/ffi/zlist.rb +30 -30
  20. data/lib/czmq-ffi-gen/czmq/ffi/zlistx.rb +44 -44
  21. data/lib/czmq-ffi-gen/czmq/ffi/zloop.rb +39 -39
  22. data/lib/czmq-ffi-gen/czmq/ffi/zmsg.rb +46 -46
  23. data/lib/czmq-ffi-gen/czmq/ffi/zpoller.rb +16 -16
  24. data/lib/czmq-ffi-gen/czmq/ffi/zproc.rb +237 -34
  25. data/lib/czmq-ffi-gen/czmq/ffi/zsock.rb +1201 -973
  26. data/lib/czmq-ffi-gen/czmq/ffi/zstr.rb +58 -19
  27. data/lib/czmq-ffi-gen/czmq/ffi/zsys.rb +836 -0
  28. data/lib/czmq-ffi-gen/czmq/ffi/ztimerset.rb +6 -6
  29. data/lib/czmq-ffi-gen/czmq/ffi/ztrie.rb +10 -10
  30. data/lib/czmq-ffi-gen/czmq/ffi/zuuid.rb +4 -4
  31. data/lib/czmq-ffi-gen/czmq/ffi.rb +224 -698
  32. data/lib/czmq-ffi-gen/gem_version.rb +1 -1
  33. data/lib/czmq-ffi-gen/vendor.rb +9 -1
  34. metadata +5 -3
@@ -76,7 +76,7 @@ module CZMQ
76
76
  # Create a new callback of the following type:
77
77
  # Comparison function e.g. for sorting and removing.
78
78
  # typedef int (zlist_compare_fn) (
79
- # void *item1, void *item2);
79
+ # void *item1, void *item2);
80
80
  #
81
81
  # @note WARNING: If your Ruby code doesn't retain a reference to the
82
82
  # FFI::Function object after passing it to a C function call,
@@ -93,7 +93,7 @@ module CZMQ
93
93
  # Create a new callback of the following type:
94
94
  # Callback function for zlist_freefn method
95
95
  # typedef void (zlist_free_fn) (
96
- # void *data);
96
+ # void *data);
97
97
  #
98
98
  # @note WARNING: If your Ruby code doesn't retain a reference to the
99
99
  # FFI::Function object after passing it to a C function call,
@@ -124,7 +124,7 @@ module CZMQ
124
124
  end
125
125
 
126
126
  # Return the item at the head of list. If the list is empty, returns NULL.
127
- # Leaves cursor pointing at the head item, or NULL if the list is empty.
127
+ # Leaves cursor pointing at the head item, or NULL if the list is empty.
128
128
  #
129
129
  # @return [::FFI::Pointer]
130
130
  def first()
@@ -135,7 +135,7 @@ module CZMQ
135
135
  end
136
136
 
137
137
  # Return the next item. If the list is empty, returns NULL. To move to
138
- # the start of the list call zlist_first (). Advances the cursor.
138
+ # the start of the list call zlist_first (). Advances the cursor.
139
139
  #
140
140
  # @return [::FFI::Pointer]
141
141
  def next()
@@ -146,7 +146,7 @@ module CZMQ
146
146
  end
147
147
 
148
148
  # Return the item at the tail of list. If the list is empty, returns NULL.
149
- # Leaves cursor pointing at the tail item, or NULL if the list is empty.
149
+ # Leaves cursor pointing at the tail item, or NULL if the list is empty.
150
150
  #
151
151
  # @return [::FFI::Pointer]
152
152
  def last()
@@ -176,7 +176,7 @@ module CZMQ
176
176
  result
177
177
  end
178
178
 
179
- # Return the current item of list. If the list is empty, returns NULL.
179
+ # Return the current item of list. If the list is empty, returns NULL.
180
180
  # Leaves cursor pointing at the current item, or NULL if the list is empty.
181
181
  #
182
182
  # @return [::FFI::Pointer]
@@ -187,9 +187,9 @@ module CZMQ
187
187
  result
188
188
  end
189
189
 
190
- # Append an item to the end of the list, return 0 if OK or -1 if this
190
+ # Append an item to the end of the list, return 0 if OK or -1 if this
191
191
  # failed for some reason (out of memory). Note that if a duplicator has
192
- # been set, this method will also duplicate the item.
192
+ # been set, this method will also duplicate the item.
193
193
  #
194
194
  # @param item [::FFI::Pointer, #to_ptr]
195
195
  # @return [Integer]
@@ -200,9 +200,9 @@ module CZMQ
200
200
  result
201
201
  end
202
202
 
203
- # Push an item to the start of the list, return 0 if OK or -1 if this
203
+ # Push an item to the start of the list, return 0 if OK or -1 if this
204
204
  # failed for some reason (out of memory). Note that if a duplicator has
205
- # been set, this method will also duplicate the item.
205
+ # been set, this method will also duplicate the item.
206
206
  #
207
207
  # @param item [::FFI::Pointer, #to_ptr]
208
208
  # @return [Integer]
@@ -223,9 +223,9 @@ module CZMQ
223
223
  result
224
224
  end
225
225
 
226
- # Checks if an item already is present. Uses compare method to determine if
226
+ # Checks if an item already is present. Uses compare method to determine if
227
227
  # items are equal. If the compare method is NULL the check will only compare
228
- # pointers. Returns true if item is present else false.
228
+ # pointers. Returns true if item is present else false.
229
229
  #
230
230
  # @param item [::FFI::Pointer, #to_ptr]
231
231
  # @return [Boolean]
@@ -247,10 +247,10 @@ module CZMQ
247
247
  result
248
248
  end
249
249
 
250
- # Make a copy of list. If the list has autofree set, the copied list will
250
+ # Make a copy of list. If the list has autofree set, the copied list will
251
251
  # duplicate all items, which must be strings. Otherwise, the list will hold
252
252
  # pointers back to the items in the original list. If list is null, returns
253
- # NULL.
253
+ # NULL.
254
254
  #
255
255
  # @return [Zlist]
256
256
  def dup()
@@ -281,11 +281,11 @@ module CZMQ
281
281
  result
282
282
  end
283
283
 
284
- # Sort the list. If the compare function is null, sorts the list by
285
- # ascending key value using a straight ASCII comparison. If you specify
284
+ # Sort the list. If the compare function is null, sorts the list by
285
+ # ascending key value using a straight ASCII comparison. If you specify
286
286
  # a compare function, this decides how items are sorted. The sort is not
287
287
  # stable, so may reorder items with the same keys. The algorithm used is
288
- # combsort, a compromise between performance and simplicity.
288
+ # combsort, a compromise between performance and simplicity.
289
289
  #
290
290
  # @param compare [::FFI::Pointer, #to_ptr]
291
291
  # @return [void]
@@ -296,14 +296,14 @@ module CZMQ
296
296
  result
297
297
  end
298
298
 
299
- # Set list for automatic item destruction; item values MUST be strings.
300
- # By default a list item refers to a value held elsewhere. When you set
299
+ # Set list for automatic item destruction; item values MUST be strings.
300
+ # By default a list item refers to a value held elsewhere. When you set
301
301
  # this, each time you append or push a list item, zlist will take a copy
302
302
  # of the string value. Then, when you destroy the list, it will free all
303
- # item values automatically. If you use any other technique to allocate
303
+ # item values automatically. If you use any other technique to allocate
304
304
  # list values, you must free them explicitly before destroying the list.
305
- # The usual technique is to pop list items and destroy them, until the
306
- # list is empty.
305
+ # The usual technique is to pop list items and destroy them, until the
306
+ # list is empty.
307
307
  #
308
308
  # @return [void]
309
309
  def autofree()
@@ -314,10 +314,10 @@ module CZMQ
314
314
  end
315
315
 
316
316
  # Sets a compare function for this list. The function compares two items.
317
- # It returns an integer less than, equal to, or greater than zero if the
318
- # first item is found, respectively, to be less than, to match, or be
319
- # greater than the second item.
320
- # This function is used for sorting, removal and exists checking.
317
+ # It returns an integer less than, equal to, or greater than zero if the
318
+ # first item is found, respectively, to be less than, to match, or be
319
+ # greater than the second item.
320
+ # This function is used for sorting, removal and exists checking.
321
321
  #
322
322
  # @param fn [::FFI::Pointer, #to_ptr]
323
323
  # @return [void]
@@ -328,11 +328,11 @@ module CZMQ
328
328
  result
329
329
  end
330
330
 
331
- # Set a free function for the specified list item. When the item is
332
- # destroyed, the free function, if any, is called on that item.
333
- # Use this when list items are dynamically allocated, to ensure that
331
+ # Set a free function for the specified list item. When the item is
332
+ # destroyed, the free function, if any, is called on that item.
333
+ # Use this when list items are dynamically allocated, to ensure that
334
334
  # you don't have memory leaks. You can pass 'free' or NULL as a free_fn.
335
- # Returns the item, or NULL if there is no such item.
335
+ # Returns the item, or NULL if there is no such item.
336
336
  #
337
337
  # @param item [::FFI::Pointer, #to_ptr]
338
338
  # @param fn [::FFI::Pointer, #to_ptr]
@@ -76,7 +76,7 @@ module CZMQ
76
76
  # Create a new callback of the following type:
77
77
  # Destroy an item
78
78
  # typedef void (zlistx_destructor_fn) (
79
- # void **item);
79
+ # void **item);
80
80
  #
81
81
  # @note WARNING: If your Ruby code doesn't retain a reference to the
82
82
  # FFI::Function object after passing it to a C function call,
@@ -92,7 +92,7 @@ module CZMQ
92
92
  # Create a new callback of the following type:
93
93
  # Duplicate an item
94
94
  # typedef void * (zlistx_duplicator_fn) (
95
- # const void *item);
95
+ # const void *item);
96
96
  #
97
97
  # @note WARNING: If your Ruby code doesn't retain a reference to the
98
98
  # FFI::Function object after passing it to a C function call,
@@ -107,7 +107,7 @@ module CZMQ
107
107
 
108
108
  # Create a new callback of the following type:
109
109
  # Compare two items, for sorting
110
- # typedef int (zlistx_comparator_fn) (
110
+ # typedef int (zlistx_comparator_fn) (
111
111
  # const void *item1, const void *item2);
112
112
  #
113
113
  # @note WARNING: If your Ruby code doesn't retain a reference to the
@@ -130,7 +130,7 @@ module CZMQ
130
130
  end
131
131
 
132
132
  # Destroy a list. If an item destructor was specified, all items in the
133
- # list are automatically destroyed as well.
133
+ # list are automatically destroyed as well.
134
134
  #
135
135
  # @return [void]
136
136
  def destroy()
@@ -141,8 +141,8 @@ module CZMQ
141
141
  end
142
142
 
143
143
  # Add an item to the head of the list. Calls the item duplicator, if any,
144
- # on the item. Resets cursor to list head. Returns an item handle on
145
- # success, NULL if memory was exhausted.
144
+ # on the item. Resets cursor to list head. Returns an item handle on
145
+ # success, NULL if memory was exhausted.
146
146
  #
147
147
  # @param item [::FFI::Pointer, #to_ptr]
148
148
  # @return [::FFI::Pointer]
@@ -154,8 +154,8 @@ module CZMQ
154
154
  end
155
155
 
156
156
  # Add an item to the tail of the list. Calls the item duplicator, if any,
157
- # on the item. Resets cursor to list head. Returns an item handle on
158
- # success, NULL if memory was exhausted.
157
+ # on the item. Resets cursor to list head. Returns an item handle on
158
+ # success, NULL if memory was exhausted.
159
159
  #
160
160
  # @param item [::FFI::Pointer, #to_ptr]
161
161
  # @return [::FFI::Pointer]
@@ -197,7 +197,7 @@ module CZMQ
197
197
  end
198
198
 
199
199
  # Return the item at the head of list. If the list is empty, returns NULL.
200
- # Leaves cursor pointing at the head item, or NULL if the list is empty.
200
+ # Leaves cursor pointing at the head item, or NULL if the list is empty.
201
201
  #
202
202
  # @return [::FFI::Pointer]
203
203
  def first()
@@ -207,9 +207,9 @@ module CZMQ
207
207
  result
208
208
  end
209
209
 
210
- # Return the next item. At the end of the list (or in an empty list),
210
+ # Return the next item. At the end of the list (or in an empty list),
211
211
  # returns NULL. Use repeated zlistx_next () calls to work through the list
212
- # from zlistx_first (). First time, acts as zlistx_first().
212
+ # from zlistx_first (). First time, acts as zlistx_first().
213
213
  #
214
214
  # @return [::FFI::Pointer]
215
215
  def next()
@@ -220,8 +220,8 @@ module CZMQ
220
220
  end
221
221
 
222
222
  # Return the previous item. At the start of the list (or in an empty list),
223
- # returns NULL. Use repeated zlistx_prev () calls to work through the list
224
- # backwards from zlistx_last (). First time, acts as zlistx_last().
223
+ # returns NULL. Use repeated zlistx_prev () calls to work through the list
224
+ # backwards from zlistx_last (). First time, acts as zlistx_last().
225
225
  #
226
226
  # @return [::FFI::Pointer]
227
227
  def prev()
@@ -232,7 +232,7 @@ module CZMQ
232
232
  end
233
233
 
234
234
  # Return the item at the tail of list. If the list is empty, returns NULL.
235
- # Leaves cursor pointing at the tail item, or NULL if the list is empty.
235
+ # Leaves cursor pointing at the tail item, or NULL if the list is empty.
236
236
  #
237
237
  # @return [::FFI::Pointer]
238
238
  def last()
@@ -243,7 +243,7 @@ module CZMQ
243
243
  end
244
244
 
245
245
  # Returns the value of the item at the cursor, or NULL if the cursor is
246
- # not pointing to an item.
246
+ # not pointing to an item.
247
247
  #
248
248
  # @return [::FFI::Pointer]
249
249
  def item()
@@ -254,7 +254,7 @@ module CZMQ
254
254
  end
255
255
 
256
256
  # Returns the handle of the item at the cursor, or NULL if the cursor is
257
- # not pointing to an item.
257
+ # not pointing to an item.
258
258
  #
259
259
  # @return [::FFI::Pointer]
260
260
  def cursor()
@@ -264,7 +264,7 @@ module CZMQ
264
264
  result
265
265
  end
266
266
 
267
- # Returns the item associated with the given list handle, or NULL if passed
267
+ # Returns the item associated with the given list handle, or NULL if passed
268
268
  # in handle is NULL. Asserts that the passed in handle points to a list element.
269
269
  #
270
270
  # @param handle [::FFI::Pointer, #to_ptr]
@@ -274,8 +274,8 @@ module CZMQ
274
274
  result
275
275
  end
276
276
 
277
- # Find an item in the list, searching from the start. Uses the item
278
- # comparator, if any, else compares item values directly. Returns the
277
+ # Find an item in the list, searching from the start. Uses the item
278
+ # comparator, if any, else compares item values directly. Returns the
279
279
  # item handle found, or NULL. Sets the cursor to the found item, if any.
280
280
  #
281
281
  # @param item [::FFI::Pointer, #to_ptr]
@@ -287,11 +287,11 @@ module CZMQ
287
287
  result
288
288
  end
289
289
 
290
- # Detach an item from the list, using its handle. The item is not modified,
290
+ # Detach an item from the list, using its handle. The item is not modified,
291
291
  # and the caller is responsible for destroying it if necessary. If handle is
292
292
  # null, detaches the first item on the list. Returns item that was detached,
293
293
  # or null if none was. If cursor was at item, moves cursor to previous item,
294
- # so you can detach items while iterating forwards through a list.
294
+ # so you can detach items while iterating forwards through a list.
295
295
  #
296
296
  # @param handle [::FFI::Pointer, #to_ptr]
297
297
  # @return [::FFI::Pointer]
@@ -303,9 +303,9 @@ module CZMQ
303
303
  end
304
304
 
305
305
  # Detach item at the cursor, if any, from the list. The item is not modified,
306
- # and the caller is responsible for destroying it as necessary. Returns item
307
- # that was detached, or null if none was. Moves cursor to previous item, so
308
- # you can detach items while iterating forwards through a list.
306
+ # and the caller is responsible for destroying it as necessary. Returns item
307
+ # that was detached, or null if none was. Moves cursor to previous item, so
308
+ # you can detach items while iterating forwards through a list.
309
309
  #
310
310
  # @return [::FFI::Pointer]
311
311
  def detach_cur()
@@ -315,11 +315,11 @@ module CZMQ
315
315
  result
316
316
  end
317
317
 
318
- # Delete an item, using its handle. Calls the item destructor is any is
319
- # set. If handle is null, deletes the first item on the list. Returns 0
318
+ # Delete an item, using its handle. Calls the item destructor is any is
319
+ # set. If handle is null, deletes the first item on the list. Returns 0
320
320
  # if an item was deleted, -1 if not. If cursor was at item, moves cursor
321
- # to previous item, so you can delete items while iterating forwards
322
- # through a list.
321
+ # to previous item, so you can delete items while iterating forwards
322
+ # through a list.
323
323
  #
324
324
  # @param handle [::FFI::Pointer, #to_ptr]
325
325
  # @return [Integer]
@@ -353,7 +353,7 @@ module CZMQ
353
353
  end
354
354
 
355
355
  # Remove all items from the list, and destroy them if the item destructor
356
- # is set.
356
+ # is set.
357
357
  #
358
358
  # @return [void]
359
359
  def purge()
@@ -363,9 +363,9 @@ module CZMQ
363
363
  result
364
364
  end
365
365
 
366
- # Sort the list. If an item comparator was set, calls that to compare
366
+ # Sort the list. If an item comparator was set, calls that to compare
367
367
  # items, otherwise compares on item value. The sort is not stable, so may
368
- # reorder equal items.
368
+ # reorder equal items.
369
369
  #
370
370
  # @return [void]
371
371
  def sort()
@@ -375,12 +375,12 @@ module CZMQ
375
375
  result
376
376
  end
377
377
 
378
- # Create a new node and insert it into a sorted list. Calls the item
379
- # duplicator, if any, on the item. If low_value is true, starts searching
380
- # from the start of the list, otherwise searches from the end. Use the item
381
- # comparator, if any, to find where to place the new node. Returns a handle
378
+ # Create a new node and insert it into a sorted list. Calls the item
379
+ # duplicator, if any, on the item. If low_value is true, starts searching
380
+ # from the start of the list, otherwise searches from the end. Use the item
381
+ # comparator, if any, to find where to place the new node. Returns a handle
382
382
  # to the new node, or NULL if memory was exhausted. Resets the cursor to the
383
- # list head.
383
+ # list head.
384
384
  #
385
385
  # @param item [::FFI::Pointer, #to_ptr]
386
386
  # @param low_value [Boolean]
@@ -393,10 +393,10 @@ module CZMQ
393
393
  result
394
394
  end
395
395
 
396
- # Move an item, specified by handle, into position in a sorted list. Uses
396
+ # Move an item, specified by handle, into position in a sorted list. Uses
397
397
  # the item comparator, if any, to determine the new location. If low_value
398
398
  # is true, starts searching from the start of the list, otherwise searches
399
- # from the end.
399
+ # from the end.
400
400
  #
401
401
  # @param handle [::FFI::Pointer, #to_ptr]
402
402
  # @param low_value [Boolean]
@@ -410,8 +410,8 @@ module CZMQ
410
410
  end
411
411
 
412
412
  # Make a copy of the list; items are duplicated if you set a duplicator
413
- # for the list, otherwise not. Copying a null reference returns a null
414
- # reference.
413
+ # for the list, otherwise not. Copying a null reference returns a null
414
+ # reference.
415
415
  #
416
416
  # @return [Zlistx]
417
417
  def dup()
@@ -423,7 +423,7 @@ module CZMQ
423
423
  end
424
424
 
425
425
  # Set a user-defined deallocator for list items; by default items are not
426
- # freed when the list is destroyed.
426
+ # freed when the list is destroyed.
427
427
  #
428
428
  # @param destructor [::FFI::Pointer, #to_ptr]
429
429
  # @return [void]
@@ -435,7 +435,7 @@ module CZMQ
435
435
  end
436
436
 
437
437
  # Set a user-defined duplicator for list items; by default items are not
438
- # copied when the list is duplicated.
438
+ # copied when the list is duplicated.
439
439
  #
440
440
  # @param duplicator [::FFI::Pointer, #to_ptr]
441
441
  # @return [void]
@@ -446,9 +446,9 @@ module CZMQ
446
446
  result
447
447
  end
448
448
 
449
- # Set a user-defined comparator for zlistx_find and zlistx_sort; the method
449
+ # Set a user-defined comparator for zlistx_find and zlistx_sort; the method
450
450
  # must return -1, 0, or 1 depending on whether item1 is less than, equal to,
451
- # or greater than, item2.
451
+ # or greater than, item2.
452
452
  #
453
453
  # @param comparator [::FFI::Pointer, #to_ptr]
454
454
  # @return [void]
@@ -75,7 +75,7 @@ module CZMQ
75
75
 
76
76
  # Create a new callback of the following type:
77
77
  # Callback function for reactor socket activity
78
- # typedef int (zloop_reader_fn) (
78
+ # typedef int (zloop_reader_fn) (
79
79
  # zloop_t *loop, zsock_t *reader, void *arg);
80
80
  #
81
81
  # @note WARNING: If your Ruby code doesn't retain a reference to the
@@ -94,7 +94,7 @@ module CZMQ
94
94
 
95
95
  # Create a new callback of the following type:
96
96
  # Callback function for reactor events (low-level)
97
- # typedef int (zloop_fn) (
97
+ # typedef int (zloop_fn) (
98
98
  # zloop_t *loop, zmq_pollitem_t *item, void *arg);
99
99
  #
100
100
  # @note WARNING: If your Ruby code doesn't retain a reference to the
@@ -112,7 +112,7 @@ module CZMQ
112
112
 
113
113
  # Create a new callback of the following type:
114
114
  # Callback for reactor timer events
115
- # typedef int (zloop_timer_fn) (
115
+ # typedef int (zloop_timer_fn) (
116
116
  # zloop_t *loop, int timer_id, void *arg);
117
117
  #
118
118
  # @note WARNING: If your Ruby code doesn't retain a reference to the
@@ -145,10 +145,10 @@ module CZMQ
145
145
  result
146
146
  end
147
147
 
148
- # Register socket reader with the reactor. When the reader has messages,
148
+ # Register socket reader with the reactor. When the reader has messages,
149
149
  # the reactor will call the handler, passing the arg. Returns 0 if OK, -1
150
- # if there was an error. If you register the same socket more than once,
151
- # each instance will invoke its corresponding handler.
150
+ # if there was an error. If you register the same socket more than once,
151
+ # each instance will invoke its corresponding handler.
152
152
  #
153
153
  # @param sock [Zsock, #__ptr]
154
154
  # @param handler [::FFI::Pointer, #to_ptr]
@@ -163,7 +163,7 @@ module CZMQ
163
163
  end
164
164
 
165
165
  # Cancel a socket reader from the reactor. If multiple readers exist for
166
- # same socket, cancels ALL of them.
166
+ # same socket, cancels ALL of them.
167
167
  #
168
168
  # @param sock [Zsock, #__ptr]
169
169
  # @return [void]
@@ -176,7 +176,7 @@ module CZMQ
176
176
  end
177
177
 
178
178
  # Configure a registered reader to ignore errors. If you do not set this,
179
- # then readers that have errors are removed from the reactor silently.
179
+ # then readers that have errors are removed from the reactor silently.
180
180
  #
181
181
  # @param sock [Zsock, #__ptr]
182
182
  # @return [void]
@@ -188,11 +188,11 @@ module CZMQ
188
188
  result
189
189
  end
190
190
 
191
- # Register low-level libzmq pollitem with the reactor. When the pollitem
192
- # is ready, will call the handler, passing the arg. Returns 0 if OK, -1
191
+ # Register low-level libzmq pollitem with the reactor. When the pollitem
192
+ # is ready, will call the handler, passing the arg. Returns 0 if OK, -1
193
193
  # if there was an error. If you register the pollitem more than once, each
194
- # instance will invoke its corresponding handler. A pollitem with
195
- # socket=NULL and fd=0 means 'poll on FD zero'.
194
+ # instance will invoke its corresponding handler. A pollitem with
195
+ # socket=NULL and fd=0 means 'poll on FD zero'.
196
196
  #
197
197
  # @param item [::FFI::Pointer, #to_ptr]
198
198
  # @param handler [::FFI::Pointer, #to_ptr]
@@ -207,7 +207,7 @@ module CZMQ
207
207
 
208
208
  # Cancel a pollitem from the reactor, specified by socket or FD. If both
209
209
  # are specified, uses only socket. If multiple poll items exist for same
210
- # socket/FD, cancels ALL of them.
210
+ # socket/FD, cancels ALL of them.
211
211
  #
212
212
  # @param item [::FFI::Pointer, #to_ptr]
213
213
  # @return [void]
@@ -219,7 +219,7 @@ module CZMQ
219
219
  end
220
220
 
221
221
  # Configure a registered poller to ignore errors. If you do not set this,
222
- # then poller that have errors are removed from the reactor silently.
222
+ # then poller that have errors are removed from the reactor silently.
223
223
  #
224
224
  # @param item [::FFI::Pointer, #to_ptr]
225
225
  # @return [void]
@@ -231,9 +231,9 @@ module CZMQ
231
231
  end
232
232
 
233
233
  # Register a timer that expires after some delay and repeats some number of
234
- # times. At each expiry, will call the handler, passing the arg. To run a
234
+ # times. At each expiry, will call the handler, passing the arg. To run a
235
235
  # timer forever, use 0 times. Returns a timer_id that is used to cancel the
236
- # timer in the future. Returns -1 if there was an error.
236
+ # timer in the future. Returns -1 if there was an error.
237
237
  #
238
238
  # @param delay [Integer, #to_int, #to_i]
239
239
  # @param times [Integer, #to_int, #to_i]
@@ -250,7 +250,7 @@ module CZMQ
250
250
  end
251
251
 
252
252
  # Cancel a specific timer identified by a specific timer_id (as returned by
253
- # zloop_timer).
253
+ # zloop_timer).
254
254
  #
255
255
  # @param timer_id [Integer, #to_int, #to_i]
256
256
  # @return [Integer]
@@ -262,15 +262,15 @@ module CZMQ
262
262
  result
263
263
  end
264
264
 
265
- # Register a ticket timer. Ticket timers are very fast in the case where
266
- # you use a lot of timers (thousands), and frequently remove and add them.
267
- # The main use case is expiry timers for servers that handle many clients,
265
+ # Register a ticket timer. Ticket timers are very fast in the case where
266
+ # you use a lot of timers (thousands), and frequently remove and add them.
267
+ # The main use case is expiry timers for servers that handle many clients,
268
268
  # and which reset the expiry timer for each message received from a client.
269
- # Whereas normal timers perform poorly as the number of clients grows, the
270
- # cost of ticket timers is constant, no matter the number of clients. You
271
- # must set the ticket delay using zloop_set_ticket_delay before creating a
272
- # ticket. Returns a handle to the timer that you should use in
273
- # zloop_ticket_reset and zloop_ticket_delete.
269
+ # Whereas normal timers perform poorly as the number of clients grows, the
270
+ # cost of ticket timers is constant, no matter the number of clients. You
271
+ # must set the ticket delay using zloop_set_ticket_delay before creating a
272
+ # ticket. Returns a handle to the timer that you should use in
273
+ # zloop_ticket_reset and zloop_ticket_delete.
274
274
  #
275
275
  # @param handler [::FFI::Pointer, #to_ptr]
276
276
  # @param arg [::FFI::Pointer, #to_ptr]
@@ -283,7 +283,7 @@ module CZMQ
283
283
  end
284
284
 
285
285
  # Reset a ticket timer, which moves it to the end of the ticket list and
286
- # resets its execution time. This is a very fast operation.
286
+ # resets its execution time. This is a very fast operation.
287
287
  #
288
288
  # @param handle [::FFI::Pointer, #to_ptr]
289
289
  # @return [void]
@@ -294,9 +294,9 @@ module CZMQ
294
294
  result
295
295
  end
296
296
 
297
- # Delete a ticket timer. We do not actually delete the ticket here, as
297
+ # Delete a ticket timer. We do not actually delete the ticket here, as
298
298
  # other code may still refer to the ticket. We mark as deleted, and remove
299
- # later and safely.
299
+ # later and safely.
300
300
  #
301
301
  # @param handle [::FFI::Pointer, #to_ptr]
302
302
  # @return [void]
@@ -307,7 +307,7 @@ module CZMQ
307
307
  result
308
308
  end
309
309
 
310
- # Set the ticket delay, which applies to all tickets. If you lower the
310
+ # Set the ticket delay, which applies to all tickets. If you lower the
311
311
  # delay and there are already tickets created, the results are undefined.
312
312
  #
313
313
  # @param ticket_delay [Integer, #to_int, #to_i]
@@ -320,11 +320,11 @@ module CZMQ
320
320
  result
321
321
  end
322
322
 
323
- # Set hard limit on number of timers allowed. Setting more than a small
323
+ # Set hard limit on number of timers allowed. Setting more than a small
324
324
  # number of timers (10-100) can have a dramatic impact on the performance
325
- # of the reactor. For high-volume cases, use ticket timers. If the hard
326
- # limit is reached, the reactor stops creating new timers and logs an
327
- # error.
325
+ # of the reactor. For high-volume cases, use ticket timers. If the hard
326
+ # limit is reached, the reactor stops creating new timers and logs an
327
+ # error.
328
328
  #
329
329
  # @param max_timers [Integer, #to_int, #to_i]
330
330
  # @return [void]
@@ -337,7 +337,7 @@ module CZMQ
337
337
  end
338
338
 
339
339
  # Set verbose tracing of reactor on/off. The default verbose setting is
340
- # off (false).
340
+ # off (false).
341
341
  #
342
342
  # @param verbose [Boolean]
343
343
  # @return [void]
@@ -349,10 +349,10 @@ module CZMQ
349
349
  result
350
350
  end
351
351
 
352
- # By default the reactor stops if the process receives a SIGINT or SIGTERM
352
+ # By default the reactor stops if the process receives a SIGINT or SIGTERM
353
353
  # signal. This makes it impossible to shut-down message based architectures
354
354
  # like zactors. This method lets you switch off break handling. The default
355
- # nonstop setting is off (false).
355
+ # nonstop setting is off (false).
356
356
  #
357
357
  # @param nonstop [Boolean]
358
358
  # @return [void]
@@ -364,10 +364,10 @@ module CZMQ
364
364
  result
365
365
  end
366
366
 
367
- # Start the reactor. Takes control of the thread and returns when the 0MQ
367
+ # Start the reactor. Takes control of the thread and returns when the 0MQ
368
368
  # context is terminated or the process is interrupted, or any event handler
369
- # returns -1. Event handlers may register new sockets and timers, and
370
- # cancel sockets. Returns 0 if interrupted, -1 if canceled by a handler.
369
+ # returns -1. Event handlers may register new sockets and timers, and
370
+ # cancel sockets. Returns 0 if interrupted, -1 if canceled by a handler.
371
371
  #
372
372
  # @return [Integer]
373
373
  def start()