-
Notifications
You must be signed in to change notification settings - Fork 32
/
socket.c
1977 lines (1799 loc) · 53.4 KB
/
socket.c
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
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "rbczmq_ext.h"
VALUE intern_on_connected;
VALUE intern_on_connect_delayed;
VALUE intern_on_connect_retried;
VALUE intern_on_listening;
VALUE intern_on_bind_failed;
VALUE intern_on_accepted;
VALUE intern_on_accept_failed;
VALUE intern_on_closed;
VALUE intern_on_close_failed;
VALUE intern_on_disconnected;
/*
* :nodoc:
* GC mark callback
*
*/
void rb_czmq_mark_sock(void *ptr)
{
zmq_sock_wrapper *sock = (zmq_sock_wrapper *)ptr;
if (sock && sock->ctx){
if (sock->verbose) {
zclock_log ("I: %s socket %p, context %p: GC mark", sock->flags & ZMQ_SOCKET_DESTROYED ? "(closed)" : zsocket_type_str(sock->socket), sock, sock->ctx);
}
rb_gc_mark(sock->endpoints);
rb_gc_mark(sock->thread);
rb_gc_mark(sock->context);
rb_gc_mark(sock->monitor_endpoint);
rb_gc_mark(sock->monitor_handler);
rb_gc_mark(sock->monitor_thread);
}
}
/*
* :nodoc:
* GC free callback
*
*/
void rb_czmq_free_sock_gc(void *ptr)
{
zmq_sock_wrapper *sock = (zmq_sock_wrapper *)ptr;
if (sock) {
if (sock->verbose) {
zclock_log ("I: %s socket %p, context %p: GC free", sock->flags & ZMQ_SOCKET_DESTROYED ? "(closed)" : zsocket_type_str(sock->socket), sock, sock ? sock->ctx : NULL);
}
/*
XXX: cyclic dependency
#4 0x0000000100712524 in zsocket_set_linger (linger=1, socket=<value temporarily unavailable, due to optimizations>) at zsocket.c:288
if (sock->socket != NULL && !(sock->flags & ZMQ_SOCKET_DESTROYED)) rb_czmq_free_sock(sock);
SOLVED:
The above occurs when a socket is not explicitly destroyed and the socket happens to be garbage
collected *after* the context has been destroyed. When the context is destroyed, all sockets
in the context are closed internally by czmq. However, the rbczmq ZMQ::Socket object still
thinks it is alive and will destroy again.
The new socket destroy method 'rb_czmq_context_destroy_socket' is idempotent and can safely
be called after either context or socket has been destroyed.
*/
rb_czmq_context_destroy_socket(sock);
xfree(sock);
}
}
/*
* call-seq:
* sock.close => nil
*
* Closes a socket. The GC will take the same action if a socket object is not reachable anymore on the next GC cycle.
* This is a lower level API.
*
* === Examples
* sock.close => nil
*
*/
static VALUE rb_czmq_socket_close(VALUE obj)
{
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqSockGuardCrossThread(sock);
/* This is useless for production / real use cases as we can't query the state again OR assume
anything about the underlying connection. Merely doing the right thing. */
sock->state = ZMQ_SOCKET_DISCONNECTED;
rb_czmq_context_destroy_socket(sock);
return Qnil;
}
/*
* call-seq:
* sock.endpoints => Array of Strings
*
* Returns the endpoints this socket is currently connected to, if any.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:PUSH)
* sock.endpoints => []
* sock.bind("inproc://test")
* sock.endpoints => ["inproc://test"]
*
*/
static VALUE rb_czmq_socket_endpoints(VALUE obj)
{
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
return sock->endpoints;
}
/*
* call-seq:
* sock.state => String
*
* Returns the current socket state, one of ZMQ::Socket::PENDING, ZMQ::Socket::BOUND or ZMQ::Socket::CONNECTED
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:PUSH)
* sock.state => ZMQ::Socket::PENDING
* sock.bind("inproc://test")
* sock.state => ZMQ::Socket::BOUND
*
*/
static VALUE rb_czmq_socket_state(VALUE obj)
{
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
return INT2NUM(sock->state);
}
/*
* call-seq:
* sock.fd => Fixnum
*
* Returns a file descriptor reference for integrating this socket with an externel event loop or multiplexor.
* Edge-triggered notification of I/O state changes.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:PUSH)
* sock.fd => -1
* sock.bind("inproc://test")
* sock.fd => 4
*
*/
static VALUE rb_czmq_socket_fd(VALUE obj)
{
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
if (sock->state == ZMQ_SOCKET_PENDING || sock->state == ZMQ_SOCKET_DISCONNECTED) return INT2NUM(-1);
return INT2NUM(zsocket_fd(sock->socket));
}
/*
* :nodoc:
* Binds to an endpoint while the GIL is released.
*
*/
VALUE rb_czmq_nogvl_socket_bind(void *ptr)
{
int rc;
struct nogvl_conn_args *args = ptr;
errno = 0;
zmq_sock_wrapper *socket = args->socket;
rc = zsocket_bind(socket->socket, "%s", args->endpoint);
return (VALUE)rc;
}
/*
* :nodoc:
* Connects to an endpoint while the GIL is released.
*
*/
VALUE rb_czmq_nogvl_socket_connect(void *ptr)
{
int rc;
struct nogvl_conn_args *args = ptr;
errno = 0;
zmq_sock_wrapper *socket = args->socket;
rc = zsocket_connect(socket->socket, "%s", args->endpoint);
return (VALUE)rc;
}
/*
* call-seq:
* sock.bind("inproc://test") => Fixnum
*
* Binds to a given endpoint. When the port number is '*', attempts to bind to a free port. Always returns the port
* number on success.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:PUSH)
* sock.bind("tcp://localhost:*") => 5432
*
*/
static VALUE rb_czmq_socket_bind(VALUE obj, VALUE endpoint)
{
struct nogvl_conn_args args;
int rc;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqSockGuardCrossThread(sock);
Check_Type(endpoint, T_STRING);
args.socket = sock;
args.endpoint = StringValueCStr(endpoint);
rc = (int)rb_thread_call_without_gvl(rb_czmq_nogvl_socket_bind, (void *)&args, RUBY_UBF_IO, 0);
/* ZmqAssert will return false on any non-zero return code. Bind returns the port number */
if (rc < 0) {
ZmqAssert(rc);
}
/* get the endpoint name with any ephemeral ports filled in. */
char* endpoint_string = zsocket_last_endpoint(sock->socket);
ZmqAssert(endpoint_string != NULL);
if (sock->verbose)
zclock_log ("I: %s socket %p: bound \"%s\"", zsocket_type_str(sock->socket), obj, endpoint_string);
sock->state = ZMQ_SOCKET_BOUND;
rb_ary_push(sock->endpoints, rb_str_new_cstr(endpoint_string));
free(endpoint_string);
return INT2NUM(rc);
}
/*
* call-seq:
* sock.connect("tcp://localhost:3456") => boolean
*
* Attempts to connect to a given endpoint.
*
* === Examples
* ctx = ZMQ::Context.new
* rep = ctx.socket(:REP)
* port = rep.bind("tcp://localhost:*") => 5432
* req = ctx.socket(:REQ)
* req.connect("tcp://localhost:#{port}") => true
*
*/
static VALUE rb_czmq_socket_connect(VALUE obj, VALUE endpoint)
{
struct nogvl_conn_args args;
int rc;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqSockGuardCrossThread(sock);
Check_Type(endpoint, T_STRING);
args.socket = sock;
args.endpoint = StringValueCStr(endpoint);
rc = (int)rb_thread_call_without_gvl(rb_czmq_nogvl_socket_connect, (void *)&args, RUBY_UBF_IO, 0);
ZmqAssert(rc);
/* get the endpoint name with any ephemeral ports filled in. */
char* endpoint_string = zsocket_last_endpoint(sock->socket);
ZmqAssert(endpoint_string != NULL);
if (sock->verbose)
zclock_log ("I: %s socket %p: connected \"%s\"", zsocket_type_str(sock->socket), obj, endpoint_string);
sock->state = ZMQ_SOCKET_CONNECTED;
rb_ary_push(sock->endpoints, rb_str_new_cstr(endpoint_string));
free(endpoint_string);
return Qtrue;
}
/*
* :nodoc:
* Disconnects from an endpoint while the GIL is released.
*
*/
VALUE rb_czmq_nogvl_socket_disconnect(void *ptr)
{
int rc;
struct nogvl_conn_args *args = ptr;
errno = 0;
zmq_sock_wrapper *socket = args->socket;
rc = zsocket_disconnect(socket->socket, "%s", args->endpoint);
return (VALUE)rc;
}
/*
* call-seq:
* sock.disconnect("tcp://localhost:3456") => boolean
*
* Attempts to disconnect from a given endpoint.
*
* === Examples
* ctx = ZMQ::Context.new
* rep = ctx.socket(:REP)
* port = rep.bind("tcp://localhost:*") => 5432
* req = ctx.socket(:REQ)
* req.connect("tcp://localhost:#{port}") => true
* req.disconnect("tcp://localhost:#{port}") => true
*
*/
static VALUE rb_czmq_socket_disconnect(VALUE obj, VALUE endpoint)
{
struct nogvl_conn_args args;
int rc;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqSockGuardCrossThread(sock);
Check_Type(endpoint, T_STRING);
args.socket = sock;
args.endpoint = StringValueCStr(endpoint);
rc = (int)rb_thread_call_without_gvl(rb_czmq_nogvl_socket_disconnect, (void *)&args, RUBY_UBF_IO, 0);
ZmqAssert(rc);
if (sock->verbose)
zclock_log ("I: %s socket %p: disconnected \"%s\"", zsocket_type_str(sock->socket), obj, StringValueCStr(endpoint));
rb_ary_delete(sock->endpoints, endpoint);
long endpoint_count = RARRAY_LEN(sock->endpoints);
if (endpoint_count == 0) {
sock->state = ZMQ_SOCKET_DISCONNECTED;
}
return Qtrue;
}
/*
* :nodoc:
* Unbinds from an endpoint while the GIL is released.
*
*/
VALUE rb_czmq_nogvl_socket_unbind(void *ptr)
{
int rc;
struct nogvl_conn_args *args = ptr;
errno = 0;
zmq_sock_wrapper *socket = args->socket;
rc = zsocket_unbind(socket->socket, "%s", args->endpoint);
return (VALUE)rc;
}
/*
* call-seq:
* sock.disconnect("tcp://localhost:3456") => boolean
*
* Attempts to disconnect from a given endpoint.
*
* === Examples
* ctx = ZMQ::Context.new
* rep = ctx.socket(:REP)
* port = rep.bind("tcp://localhost:*") => 5432
* req = ctx.socket(:REQ)
* req.connect("tcp://localhost:#{port}") => true
* rep.unbind("tcp://localhost:#{port}") => true
*
*/
static VALUE rb_czmq_socket_unbind(VALUE obj, VALUE endpoint)
{
struct nogvl_conn_args args;
int rc;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqSockGuardCrossThread(sock);
Check_Type(endpoint, T_STRING);
args.socket = sock;
args.endpoint = StringValueCStr(endpoint);
rc = (int)rb_thread_call_without_gvl(rb_czmq_nogvl_socket_unbind, (void *)&args, RUBY_UBF_IO, 0);
ZmqAssert(rc);
if (sock->verbose)
zclock_log ("I: %s socket %p: unbound \"%s\"", zsocket_type_str(sock->socket), obj, StringValueCStr(endpoint));
rb_ary_delete(sock->endpoints, endpoint);
long endpoint_count = RARRAY_LEN(sock->endpoints);
if (endpoint_count == 0) {
sock->state = ZMQ_SOCKET_DISCONNECTED;
}
return Qtrue;
}
/*
* call-seq:
* sock.verbose = true => nil
*
* Let this socket be verbose - dumps a lot of data to stdout for debugging.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.verbose = true => nil
*
*/
static VALUE rb_czmq_socket_set_verbose(VALUE obj, VALUE level)
{
bool vlevel;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
vlevel = (level == Qtrue) ? true : false;
sock->verbose = vlevel;
return Qnil;
}
/*
* :nodoc:
*
* Based on czmq `s_send_string` to send a C string. We need to be able to support
* strings that contain null bytes, so we cannot use zstr_send as it is intended for
* null terminated C strings.
*/
static int rb_czmq_nogvl_zstr_send_internal(struct nogvl_send_args *args, int flags)
{
errno = 0;
zmq_sock_wrapper *socket = args->socket;
zmq_msg_t message;
zmq_msg_init_size(&message, args->length);
memcpy(zmq_msg_data(&message), args->msg, args->length);
int rc = zmq_sendmsg(socket->socket, &message, flags);
return (rc == -1? -1: 0);
}
/*
* :nodoc:
* Sends a raw string while the GIL is released.
*
*/
static VALUE rb_czmq_nogvl_zstr_send(void *ptr)
{
struct nogvl_send_args *args = ptr;
errno = 0;
int rc = rb_czmq_nogvl_zstr_send_internal(args, 0);
return (VALUE)rc;
}
/*
* :nodoc:
* Sends a raw string with the multi flag set while the GIL is released.
*
*/
static VALUE rb_czmq_nogvl_zstr_sendm(void *ptr)
{
struct nogvl_send_args *args = ptr;
errno = 0;
int rc = rb_czmq_nogvl_zstr_send_internal(args, ZMQ_SNDMORE);
return (VALUE)rc;
}
/*
* call-seq:
* sock.send("message") => boolean
*
* Sends a string to this ZMQ socket.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REQ)
* sock.connect("inproc://test")
* sock.send("message") => true
*
*/
static VALUE rb_czmq_socket_send(VALUE obj, VALUE msg)
{
int rc;
struct nogvl_send_args args;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqAssertSocketNotPending(sock, "can only send on a bound or connected socket!");
ZmqSockGuardCrossThread(sock);
args.socket = sock;
StringValue(msg);
Check_Type(msg, T_STRING);
args.msg = RSTRING_PTR(msg);
args.length = RSTRING_LEN(msg);
rc = (int)rb_thread_call_without_gvl(rb_czmq_nogvl_zstr_send, (void *)&args, RUBY_UBF_IO, 0);
ZmqAssert(rc);
if (sock->verbose)
zclock_log ("I: %s socket %p: send \"%s\"", zsocket_type_str(sock->socket), obj, StringValueCStr(msg));
return Qtrue;
}
/*
* call-seq:
* sock.sendm("message") => boolean
*
* Sends a string to this ZMQ socket, with a more flag set.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REQ)
* sock.connect("inproc://test")
* sock.sendm("mes") => true
* sock.sendm("sage") => true
*
*/
static VALUE rb_czmq_socket_sendm(VALUE obj, VALUE msg)
{
int rc;
struct nogvl_send_args args;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqAssertSocketNotPending(sock, "can only send on a bound or connected socket!");
ZmqSockGuardCrossThread(sock);
args.socket = sock;
StringValue(msg);
Check_Type(msg, T_STRING);
args.msg = RSTRING_PTR(msg);
args.length = RSTRING_LEN(msg);
rc = (int)rb_thread_call_without_gvl(rb_czmq_nogvl_zstr_sendm, (void *)&args, RUBY_UBF_IO, 0);
ZmqAssert(rc);
if (sock->verbose)
zclock_log ("I: %s socket %p: sendm \"%s\"", zsocket_type_str(sock->socket), sock->socket, StringValueCStr(msg));
return Qtrue;
}
/*
* :nodoc:
* Receives a raw string while the GIL is released.
*
*/
static VALUE rb_czmq_nogvl_recv(void *ptr)
{
struct nogvl_recv_args *args = ptr;
errno = 0;
zmq_sock_wrapper *socket = args->socket;
// implement similar to zstr_recv, except that the copy to the string is done
// after we return with the GIL so that the ruby string object can be created
// from the zmq message buffer in a single copy.
assert (socket->socket);
int rc = zmq_recvmsg(socket->socket, &args->message, 0);
return (VALUE)rc;
}
/*
* call-seq:
* sock.recv => String or nil
*
* Receive a string from this ZMQ socket. May block depending on the socket type.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.bind("inproc://test")
* sock.recv => "message"
*
*/
static VALUE rb_czmq_socket_recv(VALUE obj)
{
char *str = NULL;
struct nogvl_recv_args args;
VALUE result = Qnil;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqAssertSocketNotPending(sock, "can only receive on a bound or connected socket!");
ZmqSockGuardCrossThread(sock);
args.socket = sock;
zmq_msg_init(&args.message);
int rc = (int)rb_thread_call_without_gvl(rb_czmq_nogvl_recv, (void *)&args, RUBY_UBF_IO, 0);
if (rc < 0) {
zmq_msg_close(&args.message);
return Qnil;
}
ZmqAssertSysError();
if (sock->verbose)
zclock_log ("I: %s socket %p: recv \"%s\"", zsocket_type_str(sock->socket), sock->socket, str);
result = rb_str_new(zmq_msg_data(&args.message), zmq_msg_size(&args.message));
zmq_msg_close(&args.message);
result = ZmqEncode(result);
return result;
}
/*
* call-seq:
* sock.recv_nonblock => String or nil
*
* Receive a string from this ZMQ socket. Does not block.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.bind("inproc://test")
* sock.recv_nonblock => "message"
*
*/
static VALUE rb_czmq_socket_recv_nonblock(VALUE obj)
{
struct nogvl_recv_args args;
errno = 0;
VALUE result = Qnil;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqAssertSocketNotPending(sock, "can only receive on a bound or connected socket!");
ZmqSockGuardCrossThread(sock);
zmq_msg_init(&args.message);
int rc = zmq_recvmsg(sock->socket, &args.message, ZMQ_DONTWAIT);
if (rc < 0) {
zmq_msg_close(&args.message);
return Qnil;
}
ZmqAssertSysError();
result = rb_str_new(zmq_msg_data(&args.message), zmq_msg_size(&args.message));
zmq_msg_close(&args.message);
if (sock->verbose) {
zclock_log ("I: %s socket %p: recv \"%s\"", zsocket_type_str(sock->socket), sock->socket, StringValueCStr(result));
}
result = ZmqEncode(result);
return result;
}
/*
* :nodoc:
* Sends a frame while the GIL is released.
*
*/
static VALUE rb_czmq_nogvl_send_frame(void *ptr)
{
struct nogvl_send_frame_args *args = ptr;
errno = 0;
zmq_sock_wrapper *socket = args->socket;
return (VALUE)zframe_send(&(args->frame), socket->socket, args->flags);
}
/*
* call-seq:
* sock.send_frame(frame) => nil
*
* Sends a ZMQ::Frame instance to this socket.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.bind("inproc://test")
* frame = ZMQ::Frame("frame")
* sock.send_frame(frame) => nil
* frame = ZMQ::Frame("multi")
* sock.send_frame(frame, ZMQ::Frame::MORE)
*
*/
static VALUE rb_czmq_socket_send_frame(int argc, VALUE *argv, VALUE obj)
{
struct nogvl_send_frame_args args;
VALUE frame_obj;
VALUE flags;
char print_prefix[255];
char *cur_time = NULL;
zframe_t *print_frame = NULL;
int rc, flgs;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqAssertSocketNotPending(sock, "can only send on a bound or connected socket!");
ZmqSockGuardCrossThread(sock);
rb_scan_args(argc, argv, "11", &frame_obj, &flags);
ZmqGetFrame(frame_obj);
ZmqAssertFrameOwnedNoMessage(frame);
if (NIL_P(flags)) {
flgs = 0;
} else {
if (SYMBOL_P(flags)) flags = rb_const_get_at(rb_cZmqFrame, rb_to_id(flags));
Check_Type(flags, T_FIXNUM);
flgs = FIX2INT(flags);
}
if (sock->verbose) {
cur_time = rb_czmq_formatted_current_time();
print_frame = (flgs & ZFRAME_REUSE) ? frame->frame : zframe_dup(frame->frame);
}
args.socket = sock;
args.frame = frame->frame;
args.flags = flgs;
rc = (int)rb_thread_call_without_gvl(rb_czmq_nogvl_send_frame, (void *)&args, RUBY_UBF_IO, 0);
ZmqAssert(rc);
if ((flgs & ZFRAME_REUSE) == 0) {
/* frame has been destroyed, clear the owns flag */
frame->flags &= ~ZMQ_FRAME_OWNED;
}
if (sock->verbose) ZmqDumpFrame("send_frame", print_frame);
return Qtrue;
}
/*
* :nodoc:
* Sends a message while the GIL is released.
*
*/
static VALUE rb_czmq_nogvl_send_message(void *ptr)
{
struct nogvl_send_message_args *args = ptr;
zmq_sock_wrapper *socket = args->socket;
errno = 0;
zmsg_send(&(args->message), socket->socket);
return Qnil;
}
/*
* call-seq:
* sock.send_message(msg) => nil
*
* Sends a ZMQ::Message instance to this socket.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.bind("inproc://test")
* msg = ZMQ::Message.new
* msg.push ZMQ::Frame("header")
* sock.send_message(msg) => nil
*
*/
static VALUE rb_czmq_socket_send_message(VALUE obj, VALUE message_obj)
{
struct nogvl_send_message_args args;
zmsg_t *print_message = NULL;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqAssertSocketNotPending(sock, "can only send on a bound or connected socket!");
ZmqSockGuardCrossThread(sock);
ZmqGetMessage(message_obj);
ZmqAssertMessageOwned(message);
if (sock->verbose) print_message = zmsg_dup(message->message);
args.socket = sock;
args.message = message->message;
rb_thread_call_without_gvl(rb_czmq_nogvl_send_message, (void *)&args, RUBY_UBF_IO, 0);
message->flags &= ~ZMQ_MESSAGE_OWNED;
if (sock->verbose) ZmqDumpMessage("send_message", print_message);
return Qnil;
}
/*
* :nodoc:
* Receives a frame while the GIL is released.
*
*/
static VALUE rb_czmq_nogvl_recv_frame(void *ptr)
{
struct nogvl_recv_args *args = ptr;
errno = 0;
zmq_sock_wrapper *socket = args->socket;
return (VALUE)zframe_recv(socket->socket);
}
/*
* call-seq:
* sock.recv_frame => ZMQ::Frame or nil
*
* Receives a ZMQ frame from this socket.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.bind("inproc://test")
* sock.recv_frame => ZMQ::Frame or nil
*
*/
static VALUE rb_czmq_socket_recv_frame(VALUE obj)
{
zframe_t *frame = NULL;
struct nogvl_recv_args args;
char print_prefix[255];
char *cur_time = NULL;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqAssertSocketNotPending(sock, "can only receive on a bound or connected socket!");
ZmqSockGuardCrossThread(sock);
args.socket = sock;
frame = (zframe_t *)rb_thread_call_without_gvl(rb_czmq_nogvl_recv_frame, (void *)&args, RUBY_UBF_IO, 0);
if (frame == NULL) return Qnil;
if (sock->verbose) {
cur_time = rb_czmq_formatted_current_time();
ZmqDumpFrame("recv_frame", frame);
}
return rb_czmq_alloc_frame(frame);
}
/*
* call-seq:
* sock.recv_frame_nonblock => ZMQ::Frame or nil
*
* Receives a ZMQ frame from this socket. Does not block
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.bind("inproc://test")
* sock.recv_frame_nonblock => ZMQ::Frame or nil
*
*/
static VALUE rb_czmq_socket_recv_frame_nonblock(VALUE obj)
{
zframe_t *frame = NULL;
char print_prefix[255];
char *cur_time = NULL;
errno = 0;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqAssertSocketNotPending(sock, "can only receive on a bound or connected socket!");
ZmqSockGuardCrossThread(sock);
frame = zframe_recv_nowait(sock->socket);
if (frame == NULL) return Qnil;
if (sock->verbose) {
cur_time = rb_czmq_formatted_current_time();
ZmqDumpFrame("recv_frame_nonblock", frame);
}
return rb_czmq_alloc_frame(frame);
}
/*
* :nodoc:
* Receives a message while the GIL is released.
*
*/
static VALUE rb_czmq_nogvl_recv_message(void *ptr)
{
struct nogvl_recv_args *args = ptr;
errno = 0;
zmq_sock_wrapper *socket = args->socket;
return (VALUE)zmsg_recv(socket->socket);
}
/*
* call-seq:
* sock.recv_message => ZMQ::Message or nil
*
* Receives a ZMQ message from this socket.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.bind("inproc://test")
* sock.recv_message => ZMQ::Message or nil
*
*/
static VALUE rb_czmq_socket_recv_message(VALUE obj)
{
zmsg_t *message = NULL;
struct nogvl_recv_args args;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
ZmqAssertSocketNotPending(sock, "can only receive on a bound or connected socket!");
ZmqSockGuardCrossThread(sock);
args.socket = sock;
message = (zmsg_t *)rb_thread_call_without_gvl(rb_czmq_nogvl_recv_message, (void *)&args, RUBY_UBF_IO, 0);
if (message == NULL) return Qnil;
if (sock->verbose) ZmqDumpMessage("recv_message", message);
return rb_czmq_alloc_message(message);
}
/*
* :nodoc:
* Poll for input while the GIL is released.
*
*/
static VALUE rb_czmq_nogvl_poll(void *ptr)
{
struct nogvl_socket_poll_args *args = ptr;
zmq_sock_wrapper *socket = args->socket;
return (VALUE)zsocket_poll(socket->socket, args->timeout);
}
/*
* call-seq:
* sock.poll(100) => Boolean
*
* Poll for input events on the socket. Returns true if there is input, otherwise false.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.bind("inproc://test")
* sock.poll(100) => true
*
*/
static VALUE rb_czmq_socket_poll(VALUE obj, VALUE timeout)
{
bool readable;
struct nogvl_socket_poll_args args;
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
Check_Type(timeout, T_FIXNUM);
ZmqSockGuardCrossThread(sock);
args.socket = sock;
args.timeout = FIX2INT(timeout);
readable = (bool)rb_thread_call_without_gvl(rb_czmq_nogvl_poll, (void *)&args, RUBY_UBF_IO, 0);
return (readable == true) ? Qtrue : Qfalse;
}
/*
* call-seq:
* sock.sndhwm => Fixnum
*
* Returns the socket send HWM (High Water Mark) value.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.sndhwm => 0
*
*/
static VALUE rb_czmq_socket_opt_sndhwm(VALUE obj)
{
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
return INT2NUM(zsocket_sndhwm(sock->socket));
}
/*
* call-seq:
* sock.sndhwm = 100 => nil
*
* Sets the socket send HWM (High Water Mark() value.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.sndhwm = 100 => nil
* sock.sndhwm => 100
*
*/
static VALUE rb_czmq_socket_set_opt_sndhwm(VALUE obj, VALUE value)
{
zmq_sock_wrapper *sock = NULL;
ZmqSetSockOpt(obj, zsocket_set_sndhwm, "SNDHWM", value);
}
/*
* call-seq:
* sock.rcvhwm => Fixnum
*
* Returns the socket receive HWM (High Water Mark) value.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.sndhwm => 0
*
*/
static VALUE rb_czmq_socket_opt_rcvhwm(VALUE obj)
{
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
return INT2NUM(zsocket_rcvhwm(sock->socket));
}
/*
* call-seq:
* sock.rcvhwm = 100 => nil
*
* Sets the socket receive HWM (High Water Mark() value.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.rcvhwm = 100 => nil
* sock.rcvhwm => 100
*
*/
static VALUE rb_czmq_socket_set_opt_rcvhwm(VALUE obj, VALUE value)
{
zmq_sock_wrapper *sock = NULL;
ZmqSetSockOpt(obj, zsocket_set_rcvhwm, "RCVHWM", value);
}
/*
* call-seq:
* sock.affinity => Fixnum
*
* Returns the socket AFFINITY value.
*
* === Examples
* ctx = ZMQ::Context.new
* sock = ctx.socket(:REP)
* sock.affinity => 0
*
*/
static VALUE rb_czmq_socket_opt_affinity(VALUE obj)
{
zmq_sock_wrapper *sock = NULL;
GetZmqSocket(obj);
return INT2NUM(zsocket_affinity(sock->socket));
}