Class: CZMQ::FFI::Zsock

Inherits:
Object
  • Object
show all
Defined in:
lib/czmq-ffi-gen/czmq/ffi/zsock.rb

Overview

Note:

This class is 100% generated using zproject.

high-level socket API that hides libzmq contexts and sockets

Defined Under Namespace

Classes: DestroyedError

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ptr, finalize = true) ⇒ Zsock

Attaches the pointer ptr to this instance and defines a finalizer for it if necessary.

Parameters:

  • ptr (::FFI::Pointer)
  • finalize (Boolean) (defaults to: true) 


24
25
26
27
28
29
30
31
32
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 24

def initialize(ptr, finalize = true)
  @ptr = ptr
  if @ptr.null?
    @ptr = nil # Remove null pointers so we don't have to test for them.
  elsif finalize
    @finalizer = self.class.create_finalizer_for @ptr
    ObjectSpace.define_finalizer self, @finalizer
  end
end

Class Method Details

.__new ⇒ Object 



18
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 18

alias :__new :new

.affinity(self_p) ⇒ Integer

Get socket option ‘affinity`. Available from libzmq 2.0.0.

This is the polymorphic version of #affinity.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3766
3767
3768
3769
3770
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3766

def self.affinity(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_affinity(self_p)
  result
end

.backlog(self_p) ⇒ Integer

Get socket option ‘backlog`. Available from libzmq 2.0.0.

This is the polymorphic version of #backlog.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4468
4469
4470
4471
4472
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4468

def self.backlog(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_backlog(self_p)
  result
end

.brecv(self_p, picture, *args) ⇒ Integer

Receive a binary encoded ‘picture’ message from the socket (or actor). This method is similar to zsock_recv, except the arguments are encoded in a binary format that is compatible with zproto, and is designed to reduce memory allocations. The pattern argument is a string that defines the type of each argument. See zsock_bsend for the supported argument types. All arguments must be pointers; this call sets them to point to values held on a per-socket basis. For types 1, 2, 4 and 8 the caller must allocate the memory itself before calling zsock_brecv. For types S, the caller must free the value once finished with it, as zsock_brecv will allocate the buffer. For type s, the caller must not free the value as it is stored in a local cache for performance purposes. For types c, f, u and m the caller must call the appropriate destructor depending on the object as zsock_brecv will create new objects. For type p the caller must coordinate with the sender, as it is just a pointer value being passed.

This is the polymorphic version of #brecv.

Parameters:

Returns:

  • (Integer) 


693
694
695
696
697
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 693

def self.brecv(self_p, picture, *args)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_brecv(self_p, picture, *args)
  result
end

.bsend(self_p, picture, *args) ⇒ Integer

Send a binary encoded ‘picture’ message to the socket (or actor). This method is similar to zsock_send, except the arguments are encoded in a binary format that is compatible with zproto, and is designed to reduce memory allocations. The pattern argument is a string that defines the type of each argument. Supports these argument types:

pattern    C type                  zproto type:
   1       uint8_t                 type = "number" size = "1"
   2       uint16_t                type = "number" size = "2"
   4       uint32_t                type = "number" size = "3"
   8       uint64_t                type = "number" size = "4"
   s       char *, 0-255 chars     type = "string"
   S       char *, 0-2^32-1 chars  type = "longstr"
   c       zchunk_t *              type = "chunk"
   f       zframe_t *              type = "frame"
   u       zuuid_t *               type = "uuid"
   m       zmsg_t *                type = "msg"
   p       void *, sends pointer value, only over inproc

Does not change or take ownership of any arguments. Returns 0 if successful, -1 if sending failed for any reason.

This is the polymorphic version of #bsend.

Parameters:

Returns:

  • (Integer) 


634
635
636
637
638
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 634

def self.bsend(self_p, picture, *args)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_bsend(self_p, picture, *args)
  result
end

.connect_timeout(self_p) ⇒ Integer

Get socket option ‘connect_timeout`. Available from libzmq 4.2.0.

This is the polymorphic version of #connect_timeout.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1320
1321
1322
1323
1324
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1320

def self.connect_timeout(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_connect_timeout(self_p)
  result
end

.create_finalizer_for(ptr) ⇒ Proc

Parameters:

  • ptr (::FFI::Pointer)

Returns:

  • (Proc) 


35
36
37
38
39
40
41
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 35

def self.create_finalizer_for(ptr)
  Proc.new do
    ptr_ptr = ::FFI::MemoryPointer.new :pointer
    ptr_ptr.write_pointer ptr
    ::CZMQ::FFI.zsock_destroy ptr_ptr
  end
end

.curve_publickey(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘curve_publickey`. Available from libzmq 4.0.0.

This is the polymorphic version of #curve_publickey.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


2438
2439
2440
2441
2442
2443
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2438

def self.curve_publickey(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_curve_publickey(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

.curve_secretkey(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘curve_secretkey`. Available from libzmq 4.0.0.

This is the polymorphic version of #curve_secretkey.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


2519
2520
2521
2522
2523
2524
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2519

def self.curve_secretkey(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_curve_secretkey(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

.curve_server(self_p) ⇒ Integer

Get socket option ‘curve_server`. Available from libzmq 4.0.0.

This is the polymorphic version of #curve_server.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


2383
2384
2385
2386
2387
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2383

def self.curve_server(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_curve_server(self_p)
  result
end

.curve_serverkey(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘curve_serverkey`. Available from libzmq 4.0.0.

This is the polymorphic version of #curve_serverkey.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


2600
2601
2602
2603
2604
2605
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2600

def self.curve_serverkey(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_curve_serverkey(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

.events(self_p) ⇒ Integer

Get socket option ‘events`. Available from libzmq 2.0.0.

This is the polymorphic version of #events.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4651
4652
4653
4654
4655
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4651

def self.events(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_events(self_p)
  result
end

.fd(self_p) ⇒ Integer or FFI::Pointer

Get socket option ‘fd`. Available from libzmq 2.0.0.

This is the polymorphic version of #fd.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer or FFI::Pointer) 


4626
4627
4628
4629
4630
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4626

def self.fd(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_fd(self_p)
  result
end

.flush(self_p) ⇒ void

This method returns an undefined value.

If there is a partial message still waiting on the socket, remove and discard it. This is useful when reading partial messages, to get specific message types.

This is the polymorphic version of #flush.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on



835
836
837
838
839
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 835

def self.flush(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_flush(self_p)
  result
end

.gssapi_plaintext(self_p) ⇒ Integer

Get socket option ‘gssapi_plaintext`. Available from libzmq 4.0.0.

This is the polymorphic version of #gssapi_plaintext.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


2734
2735
2736
2737
2738
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2734

def self.gssapi_plaintext(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_gssapi_plaintext(self_p)
  result
end

.gssapi_principal(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘gssapi_principal`. Available from libzmq 4.0.0.

This is the polymorphic version of #gssapi_principal.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


2789
2790
2791
2792
2793
2794
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2789

def self.gssapi_principal(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_gssapi_principal(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

.gssapi_server(self_p) ⇒ Integer

Get socket option ‘gssapi_server`. Available from libzmq 4.0.0.

This is the polymorphic version of #gssapi_server.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


2680
2681
2682
2683
2684
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2680

def self.gssapi_server(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_gssapi_server(self_p)
  result
end

.gssapi_service_principal(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘gssapi_service_principal`. Available from libzmq 4.0.0.

This is the polymorphic version of #gssapi_service_principal.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


2843
2844
2845
2846
2847
2848
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2843

def self.gssapi_service_principal(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_gssapi_service_principal(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

.handshake_ivl(self_p) ⇒ Integer

Get socket option ‘handshake_ivl`. Available from libzmq 4.1.0.

This is the polymorphic version of #handshake_ivl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1860
1861
1862
1863
1864
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1860

def self.handshake_ivl(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_handshake_ivl(self_p)
  result
end

.heartbeat_ivl(self_p) ⇒ Integer

Get socket option ‘heartbeat_ivl`. Available from libzmq 4.2.0.

This is the polymorphic version of #heartbeat_ivl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


936
937
938
939
940
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 936

def self.heartbeat_ivl(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_heartbeat_ivl(self_p)
  result
end

.heartbeat_timeout(self_p) ⇒ Integer

Get socket option ‘heartbeat_timeout`. Available from libzmq 4.2.0.

This is the polymorphic version of #heartbeat_timeout.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1044
1045
1046
1047
1048
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1044

def self.heartbeat_timeout(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_heartbeat_timeout(self_p)
  result
end

.heartbeat_ttl(self_p) ⇒ Integer

Get socket option ‘heartbeat_ttl`. Available from libzmq 4.2.0.

This is the polymorphic version of #heartbeat_ttl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


990
991
992
993
994
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 990

def self.heartbeat_ttl(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_heartbeat_ttl(self_p)
  result
end

.hwm(self_p) ⇒ Integer

Get socket option ‘hwm`. Available from libzmq 2.0.0 to 3.0.0.

This is the polymorphic version of #hwm.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3658
3659
3660
3661
3662
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3658

def self.hwm(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_hwm(self_p)
  result
end

.identity(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘identity`. Available from libzmq 2.0.0.

This is the polymorphic version of #identity.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


3821
3822
3823
3824
3825
3826
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3821

def self.identity(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_identity(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

.immediate(self_p) ⇒ Integer

Get socket option ‘immediate`. Available from libzmq 4.0.0.

This is the polymorphic version of #immediate.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


2950
2951
2952
2953
2954
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2950

def self.immediate(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_immediate(self_p)
  result
end

.invert_matching(self_p) ⇒ Integer

Get socket option ‘invert_matching`. Available from libzmq 4.2.0.

This is the polymorphic version of #invert_matching.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1237
1238
1239
1240
1241
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1237

def self.invert_matching(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_invert_matching(self_p)
  result
end

.ipv4only(self_p) ⇒ Integer

Get socket option ‘ipv4only`. Available from libzmq 3.0.0.

This is the polymorphic version of #ipv4only.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3575
3576
3577
3578
3579
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3575

def self.ipv4only(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_ipv4only(self_p)
  result
end

.ipv6(self_p) ⇒ Integer

Get socket option ‘ipv6`. Available from libzmq 4.0.0.

This is the polymorphic version of #ipv6.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


2896
2897
2898
2899
2900
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2896

def self.ipv6(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_ipv6(self_p)
  result
end

.is(self_) ⇒ Boolean

Probe the supplied object, and report if it looks like a zsock_t. Takes a polymorphic socket reference.

Parameters:

  • self_ (::FFI::Pointer, #to_ptr)

Returns:

  • (Boolean) 


900
901
902
903
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 900

def self.is(self_)
  result = ::CZMQ::FFI.zsock_is(self_)
  result
end

.join(self_p, group) ⇒ Integer

Join a group for the RADIO-DISH pattern. Call only on ZMQ_DISH. Returns 0 if OK, -1 if failed.

This is the polymorphic version of #join.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • group (String, #to_s, nil)

Returns:

  • (Integer) 


862
863
864
865
866
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 862

def self.join(self_p, group)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_join(self_p, group)
  result
end

.last_endpoint(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘last_endpoint`. Available from libzmq 3.0.0.

This is the polymorphic version of #last_endpoint.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


3520
3521
3522
3523
3524
3525
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3520

def self.last_endpoint(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_last_endpoint(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

.leave(self_p, group) ⇒ Integer

Leave a group for the RADIO-DISH pattern. Call only on ZMQ_DISH. Returns 0 if OK, -1 if failed.

This is the polymorphic version of #leave.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • group (String, #to_s, nil)

Returns:

  • (Integer) 


889
890
891
892
893
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 889

def self.leave(self_p, group)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_leave(self_p, group)
  result
end

.linger(self_p) ⇒ Integer

Get socket option ‘linger`. Available from libzmq 2.0.0.

This is the polymorphic version of #linger.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4306
4307
4308
4309
4310
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4306

def self.linger(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_linger(self_p)
  result
end

.maxmsgsize(self_p) ⇒ Integer

Get socket option ‘maxmsgsize`. Available from libzmq 3.0.0.

This is the polymorphic version of #maxmsgsize.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3112
3113
3114
3115
3116
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3112

def self.maxmsgsize(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_maxmsgsize(self_p)
  result
end

.mcast_loop(self_p) ⇒ Integer

Get socket option ‘mcast_loop`. Available from libzmq 2.0.0 to 3.0.0.

This is the polymorphic version of #mcast_loop.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4036
4037
4038
4039
4040
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4036

def self.mcast_loop(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_mcast_loop(self_p)
  result
end

.mechanism(self_p) ⇒ Integer

Get socket option ‘mechanism`. Available from libzmq 4.0.0.

This is the polymorphic version of #mechanism.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


2196
2197
2198
2199
2200
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2196

def self.mechanism(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_mechanism(self_p)
  result
end

.multicast_hops(self_p) ⇒ Integer

Get socket option ‘multicast_hops`. Available from libzmq 3.0.0.

This is the polymorphic version of #multicast_hops.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3166
3167
3168
3169
3170
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3166

def self.multicast_hops(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_multicast_hops(self_p)
  result
end

.multicast_maxtpdu(self_p) ⇒ Integer

Get socket option ‘multicast_maxtpdu`. Available from libzmq 4.2.0.

This is the polymorphic version of #multicast_maxtpdu.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1453
1454
1455
1456
1457
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1453

def self.multicast_maxtpdu(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_multicast_maxtpdu(self_p)
  result
end

.new(type) ⇒ CZMQ::Zsock

Create a new socket. Returns the new socket, or NULL if the new socket could not be created. Note that the symbol zsock_new (and other constructors/destructors for zsock) are redirected to the *_checked variant, enabling intelligent socket leak detection. This can have performance implications if you use a LOT of sockets. To turn off this redirection behaviour, define ZSOCK_NOCHECK.

Parameters:

  • type (Integer, #to_int, #to_i)

Returns:

  • (CZMQ::Zsock) 


84
85
86
87
88
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 84

def self.new(type)
  type = Integer(type)
  ptr = ::CZMQ::FFI.zsock_new(type)
  __new ptr
end

.new_client(endpoint) ⇒ CZMQ::Zsock

Create a CLIENT socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


199
200
201
202
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 199

def self.new_client(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_client(endpoint)
  __new ptr
end

.new_dealer(endpoint) ⇒ CZMQ::Zsock

Create a DEALER socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


127
128
129
130
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 127

def self.new_dealer(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_dealer(endpoint)
  __new ptr
end

.new_dish(endpoint) ⇒ CZMQ::Zsock

Create a DISH socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


215
216
217
218
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 215

def self.new_dish(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_dish(endpoint)
  __new ptr
end

.new_gather(endpoint) ⇒ CZMQ::Zsock

Create a GATHER socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


223
224
225
226
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 223

def self.new_gather(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_gather(endpoint)
  __new ptr
end

.new_pair(endpoint) ⇒ CZMQ::Zsock

Create a PAIR socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


175
176
177
178
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 175

def self.new_pair(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_pair(endpoint)
  __new ptr
end

.new_pub(endpoint) ⇒ CZMQ::Zsock

Create a PUB socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


93
94
95
96
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 93

def self.new_pub(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_pub(endpoint)
  __new ptr
end

.new_pull(endpoint) ⇒ CZMQ::Zsock

Create a PULL socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


151
152
153
154
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 151

def self.new_pull(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_pull(endpoint)
  __new ptr
end

.new_push(endpoint) ⇒ CZMQ::Zsock

Create a PUSH socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


143
144
145
146
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 143

def self.new_push(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_push(endpoint)
  __new ptr
end

.new_radio(endpoint) ⇒ CZMQ::Zsock

Create a RADIO socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


207
208
209
210
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 207

def self.new_radio(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_radio(endpoint)
  __new ptr
end

.new_rep(endpoint) ⇒ CZMQ::Zsock

Create a REP socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


119
120
121
122
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 119

def self.new_rep(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_rep(endpoint)
  __new ptr
end

.new_req(endpoint) ⇒ CZMQ::Zsock

Create a REQ socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


111
112
113
114
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 111

def self.new_req(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_req(endpoint)
  __new ptr
end

.new_router(endpoint) ⇒ CZMQ::Zsock

Create a ROUTER socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


135
136
137
138
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 135

def self.new_router(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_router(endpoint)
  __new ptr
end

.new_scatter(endpoint) ⇒ CZMQ::Zsock

Create a SCATTER socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


231
232
233
234
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 231

def self.new_scatter(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_scatter(endpoint)
  __new ptr
end

.new_server(endpoint) ⇒ CZMQ::Zsock

Create a SERVER socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


191
192
193
194
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 191

def self.new_server(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_server(endpoint)
  __new ptr
end

.new_stream(endpoint) ⇒ CZMQ::Zsock

Create a STREAM socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


183
184
185
186
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 183

def self.new_stream(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_stream(endpoint)
  __new ptr
end

.new_sub(endpoint, subscribe) ⇒ CZMQ::Zsock

Create a SUB socket, and optionally subscribe to some prefix string. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)
  • subscribe (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


103
104
105
106
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 103

def self.new_sub(endpoint, subscribe)
  ptr = ::CZMQ::FFI.zsock_new_sub(endpoint, subscribe)
  __new ptr
end

.new_xpub(endpoint) ⇒ CZMQ::Zsock

Create an XPUB socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


159
160
161
162
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 159

def self.new_xpub(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_xpub(endpoint)
  __new ptr
end

.new_xsub(endpoint) ⇒ CZMQ::Zsock

Create an XSUB socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock) 


167
168
169
170
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 167

def self.new_xsub(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_xsub(endpoint)
  __new ptr
end

.plain_password(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘plain_password`. Available from libzmq 4.0.0.

This is the polymorphic version of #plain_password.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


2330
2331
2332
2333
2334
2335
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2330

def self.plain_password(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_plain_password(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

.plain_server(self_p) ⇒ Integer

Get socket option ‘plain_server`. Available from libzmq 4.0.0.

This is the polymorphic version of #plain_server.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


2221
2222
2223
2224
2225
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2221

def self.plain_server(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_plain_server(self_p)
  result
end

.plain_username(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘plain_username`. Available from libzmq 4.0.0.

This is the polymorphic version of #plain_username.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


2276
2277
2278
2279
2280
2281
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2276

def self.plain_username(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_plain_username(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

.rate(self_p) ⇒ Integer

Get socket option ‘rate`. Available from libzmq 2.0.0.

This is the polymorphic version of #rate.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3874
3875
3876
3877
3878
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3874

def self.rate(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_rate(self_p)
  result
end

.rcvbuf(self_p) ⇒ Integer

Get socket option ‘rcvbuf`. Available from libzmq 2.0.0.

This is the polymorphic version of #rcvbuf.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4252
4253
4254
4255
4256
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4252

def self.rcvbuf(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_rcvbuf(self_p)
  result
end

.rcvhwm(self_p) ⇒ Integer

Get socket option ‘rcvhwm`. Available from libzmq 3.0.0.

This is the polymorphic version of #rcvhwm.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3058
3059
3060
3061
3062
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3058

def self.rcvhwm(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_rcvhwm(self_p)
  result
end

.rcvmore(self_p) ⇒ Integer

Get socket option ‘rcvmore`. Available from libzmq 2.0.0.

This is the polymorphic version of #rcvmore.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4601
4602
4603
4604
4605
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4601

def self.rcvmore(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_rcvmore(self_p)
  result
end

.rcvtimeo(self_p) ⇒ Integer

Get socket option ‘rcvtimeo`. Available from libzmq 2.2.0.

This is the polymorphic version of #rcvtimeo.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4090
4091
4092
4093
4094
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4090

def self.rcvtimeo(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_rcvtimeo(self_p)
  result
end

.reconnect_ivl(self_p) ⇒ Integer

Get socket option ‘reconnect_ivl`. Available from libzmq 2.0.0.

This is the polymorphic version of #reconnect_ivl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4360
4361
4362
4363
4364
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4360

def self.reconnect_ivl(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_reconnect_ivl(self_p)
  result
end

.reconnect_ivl_max(self_p) ⇒ Integer

Get socket option ‘reconnect_ivl_max`. Available from libzmq 2.0.0.

This is the polymorphic version of #reconnect_ivl_max.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4414
4415
4416
4417
4418
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4414

def self.reconnect_ivl_max(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_reconnect_ivl_max(self_p)
  result
end

.recovery_ivl(self_p) ⇒ Integer

Get socket option ‘recovery_ivl`. Available from libzmq 2.0.0.

This is the polymorphic version of #recovery_ivl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3928
3929
3930
3931
3932
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3928

def self.recovery_ivl(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_recovery_ivl(self_p)
  result
end

.recovery_ivl_msec(self_p) ⇒ Integer

Get socket option ‘recovery_ivl_msec`. Available from libzmq 2.0.0 to 3.0.0.

This is the polymorphic version of #recovery_ivl_msec.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3982
3983
3984
3985
3986
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3982

def self.recovery_ivl_msec(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_recovery_ivl_msec(self_p)
  result
end

.recv(self_p, picture, *args) ⇒ Integer

Receive a ‘picture’ message to the socket (or actor). See zsock_send for the format and meaning of the picture. Returns the picture elements into a series of pointers as provided by the caller:

i = int * (stores signed integer)
4 = uint32_t * (stores 32-bit unsigned integer)
8 = uint64_t * (stores 64-bit unsigned integer)
s = char ** (allocates new string)
b = byte **, size_t * (2 arguments) (allocates memory)
c = zchunk_t ** (creates zchunk)
f = zframe_t ** (creates zframe)
U = zuuid_t * (creates a zuuid with the data)
h = zhashx_t ** (creates zhashx)
p = void ** (stores pointer)
m = zmsg_t ** (creates a zmsg with the remaing frames)
z = null, asserts empty frame (0 arguments)
u = uint * (stores unsigned integer, deprecated)

Note that zsock_recv creates the returned objects, and the caller must destroy them when finished with them. The supplied pointers do not need to be initialized. Returns 0 if successful, or -1 if it failed to recv a message, in which case the pointers are not modified. When message frames are truncated (a short message), sets return values to zero/null. If an argument pointer is NULL, does not store any value (skips it). An ‘n’ picture matches an empty frame; if the message does not match, the method will return -1.

This is the polymorphic version of #recv.

Parameters:

Returns:

  • (Integer) 


536
537
538
539
540
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 536

def self.recv(self_p, picture, *args)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_recv(self_p, picture, *args)
  result
end

.resolve(self_) ⇒ ::FFI::Pointer

Probe the supplied reference. If it looks like a zsock_t instance, return the underlying libzmq socket handle; else if it looks like a file descriptor, return NULL; else if it looks like a libzmq socket handle, return the supplied value. Takes a polymorphic socket reference.

Parameters:

  • self_ (::FFI::Pointer, #to_ptr)

Returns:

  • (::FFI::Pointer) 


912
913
914
915
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 912

def self.resolve(self_)
  result = ::CZMQ::FFI.zsock_resolve(self_)
  result
end

.send(self_p, picture, *args) ⇒ Integer

Send a ‘picture’ message to the socket (or actor). The picture is a string that defines the type of each frame. This makes it easy to send a complex multiframe message in one call. The picture can contain any of these characters, each corresponding to one or two arguments:

i = int (signed)
1 = uint8_t
2 = uint16_t
4 = uint32_t
8 = uint64_t
s = char *
b = byte *, size_t (2 arguments)
c = zchunk_t *
f = zframe_t *
h = zhashx_t *
U = zuuid_t *
p = void * (sends the pointer value, only meaningful over inproc)
m = zmsg_t * (sends all frames in the zmsg)
z = sends zero-sized frame (0 arguments)
u = uint (deprecated)

Note that s, b, c, and f are encoded the same way and the choice is offered as a convenience to the sender, which may or may not already have data in a zchunk or zframe. Does not change or take ownership of any arguments. Returns 0 if successful, -1 if sending failed for any reason.

This is the polymorphic version of #send.

Parameters:

Returns:

  • (Integer) 


428
429
430
431
432
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 428

def self.send(self_p, picture, *args)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_send(self_p, picture, *args)
  result
end

.set_affinity(self_p, affinity) ⇒ void

This method returns an undefined value.

Set socket option ‘affinity`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_affinity.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • affinity (Integer, #to_int, #to_i) 


3794
3795
3796
3797
3798
3799
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3794

def self.set_affinity(self_p, affinity)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  affinity = Integer(affinity)
  result = ::CZMQ::FFI.zsock_set_affinity(self_p, affinity)
  result
end

.set_backlog(self_p, backlog) ⇒ void

This method returns an undefined value.

Set socket option ‘backlog`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_backlog.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • backlog (Integer, #to_int, #to_i) 


4496
4497
4498
4499
4500
4501
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4496

def self.set_backlog(self_p, backlog)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  backlog = Integer(backlog)
  result = ::CZMQ::FFI.zsock_set_backlog(self_p, backlog)
  result
end

.set_conflate(self_p, conflate) ⇒ void

This method returns an undefined value.

Set socket option ‘conflate`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_conflate.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • conflate (Integer, #to_int, #to_i) 


2116
2117
2118
2119
2120
2121
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2116

def self.set_conflate(self_p, conflate)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  conflate = Integer(conflate)
  result = ::CZMQ::FFI.zsock_set_conflate(self_p, conflate)
  result
end

.set_connect_rid(self_p, connect_rid) ⇒ void

This method returns an undefined value.

Set socket option ‘connect_rid`. Available from libzmq 4.1.0.

This is the polymorphic version of #set_connect_rid.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • connect_rid (String, #to_s, nil) 


1808
1809
1810
1811
1812
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1808

def self.set_connect_rid(self_p, connect_rid)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_connect_rid(self_p, connect_rid)
  result
end

.set_connect_rid_bin(self_p, connect_rid) ⇒ void

This method returns an undefined value.

Set socket option ‘connect_rid` from 32-octet binary Available from libzmq 4.1.0.

This is the polymorphic version of #set_connect_rid_bin.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • connect_rid (::FFI::Pointer, #to_ptr) 


1835
1836
1837
1838
1839
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1835

def self.set_connect_rid_bin(self_p, connect_rid)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_connect_rid_bin(self_p, connect_rid)
  result
end

.set_connect_timeout(self_p, connect_timeout) ⇒ void

This method returns an undefined value.

Set socket option ‘connect_timeout`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_connect_timeout.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • connect_timeout (Integer, #to_int, #to_i) 


1348
1349
1350
1351
1352
1353
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1348

def self.set_connect_timeout(self_p, connect_timeout)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  connect_timeout = Integer(connect_timeout)
  result = ::CZMQ::FFI.zsock_set_connect_timeout(self_p, connect_timeout)
  result
end

.set_curve_publickey(self_p, curve_publickey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_publickey`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_curve_publickey.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • curve_publickey (String, #to_s, nil) 


2466
2467
2468
2469
2470
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2466

def self.set_curve_publickey(self_p, curve_publickey)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_curve_publickey(self_p, curve_publickey)
  result
end

.set_curve_publickey_bin(self_p, curve_publickey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_publickey` from 32-octet binary Available from libzmq 4.0.0.

This is the polymorphic version of #set_curve_publickey_bin.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • curve_publickey (::FFI::Pointer, #to_ptr) 


2493
2494
2495
2496
2497
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2493

def self.set_curve_publickey_bin(self_p, curve_publickey)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_curve_publickey_bin(self_p, curve_publickey)
  result
end

.set_curve_secretkey(self_p, curve_secretkey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_secretkey`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_curve_secretkey.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • curve_secretkey (String, #to_s, nil) 


2547
2548
2549
2550
2551
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2547

def self.set_curve_secretkey(self_p, curve_secretkey)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_curve_secretkey(self_p, curve_secretkey)
  result
end

.set_curve_secretkey_bin(self_p, curve_secretkey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_secretkey` from 32-octet binary Available from libzmq 4.0.0.

This is the polymorphic version of #set_curve_secretkey_bin.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • curve_secretkey (::FFI::Pointer, #to_ptr) 


2574
2575
2576
2577
2578
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2574

def self.set_curve_secretkey_bin(self_p, curve_secretkey)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_curve_secretkey_bin(self_p, curve_secretkey)
  result
end

.set_curve_server(self_p, curve_server) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_server`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_curve_server.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • curve_server (Integer, #to_int, #to_i) 


2411
2412
2413
2414
2415
2416
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2411

def self.set_curve_server(self_p, curve_server)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  curve_server = Integer(curve_server)
  result = ::CZMQ::FFI.zsock_set_curve_server(self_p, curve_server)
  result
end

.set_curve_serverkey(self_p, curve_serverkey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_serverkey`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_curve_serverkey.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • curve_serverkey (String, #to_s, nil) 


2628
2629
2630
2631
2632
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2628

def self.set_curve_serverkey(self_p, curve_serverkey)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_curve_serverkey(self_p, curve_serverkey)
  result
end

.set_curve_serverkey_bin(self_p, curve_serverkey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_serverkey` from 32-octet binary Available from libzmq 4.0.0.

This is the polymorphic version of #set_curve_serverkey_bin.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • curve_serverkey (::FFI::Pointer, #to_ptr) 


2655
2656
2657
2658
2659
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2655

def self.set_curve_serverkey_bin(self_p, curve_serverkey)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_curve_serverkey_bin(self_p, curve_serverkey)
  result
end

.set_delay_attach_on_connect(self_p, delay_attach_on_connect) ⇒ void

This method returns an undefined value.

Set socket option ‘delay_attach_on_connect`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_delay_attach_on_connect.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • delay_attach_on_connect (Integer, #to_int, #to_i) 


3632
3633
3634
3635
3636
3637
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3632

def self.set_delay_attach_on_connect(self_p, delay_attach_on_connect)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  delay_attach_on_connect = Integer(delay_attach_on_connect)
  result = ::CZMQ::FFI.zsock_set_delay_attach_on_connect(self_p, delay_attach_on_connect)
  result
end

.set_gssapi_plaintext(self_p, gssapi_plaintext) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_plaintext`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_gssapi_plaintext.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • gssapi_plaintext (Integer, #to_int, #to_i) 


2762
2763
2764
2765
2766
2767
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2762

def self.set_gssapi_plaintext(self_p, gssapi_plaintext)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  gssapi_plaintext = Integer(gssapi_plaintext)
  result = ::CZMQ::FFI.zsock_set_gssapi_plaintext(self_p, gssapi_plaintext)
  result
end

.set_gssapi_principal(self_p, gssapi_principal) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_principal`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_gssapi_principal.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • gssapi_principal (String, #to_s, nil) 


2817
2818
2819
2820
2821
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2817

def self.set_gssapi_principal(self_p, gssapi_principal)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_gssapi_principal(self_p, gssapi_principal)
  result
end

.set_gssapi_server(self_p, gssapi_server) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_server`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_gssapi_server.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • gssapi_server (Integer, #to_int, #to_i) 


2708
2709
2710
2711
2712
2713
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2708

def self.set_gssapi_server(self_p, gssapi_server)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  gssapi_server = Integer(gssapi_server)
  result = ::CZMQ::FFI.zsock_set_gssapi_server(self_p, gssapi_server)
  result
end

.set_gssapi_service_principal(self_p, gssapi_service_principal) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_service_principal`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_gssapi_service_principal.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • gssapi_service_principal (String, #to_s, nil) 


2871
2872
2873
2874
2875
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2871

def self.set_gssapi_service_principal(self_p, gssapi_service_principal)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_gssapi_service_principal(self_p, gssapi_service_principal)
  result
end

.set_handshake_ivl(self_p, handshake_ivl) ⇒ void

This method returns an undefined value.

Set socket option ‘handshake_ivl`. Available from libzmq 4.1.0.

This is the polymorphic version of #set_handshake_ivl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • handshake_ivl (Integer, #to_int, #to_i) 


1888
1889
1890
1891
1892
1893
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1888

def self.set_handshake_ivl(self_p, handshake_ivl)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  handshake_ivl = Integer(handshake_ivl)
  result = ::CZMQ::FFI.zsock_set_handshake_ivl(self_p, handshake_ivl)
  result
end

.set_heartbeat_ivl(self_p, heartbeat_ivl) ⇒ void

This method returns an undefined value.

Set socket option ‘heartbeat_ivl`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_heartbeat_ivl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • heartbeat_ivl (Integer, #to_int, #to_i) 


964
965
966
967
968
969
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 964

def self.set_heartbeat_ivl(self_p, heartbeat_ivl)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  heartbeat_ivl = Integer(heartbeat_ivl)
  result = ::CZMQ::FFI.zsock_set_heartbeat_ivl(self_p, heartbeat_ivl)
  result
end

.set_heartbeat_timeout(self_p, heartbeat_timeout) ⇒ void

This method returns an undefined value.

Set socket option ‘heartbeat_timeout`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_heartbeat_timeout.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • heartbeat_timeout (Integer, #to_int, #to_i) 


1072
1073
1074
1075
1076
1077
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1072

def self.set_heartbeat_timeout(self_p, heartbeat_timeout)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  heartbeat_timeout = Integer(heartbeat_timeout)
  result = ::CZMQ::FFI.zsock_set_heartbeat_timeout(self_p, heartbeat_timeout)
  result
end

.set_heartbeat_ttl(self_p, heartbeat_ttl) ⇒ void

This method returns an undefined value.

Set socket option ‘heartbeat_ttl`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_heartbeat_ttl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • heartbeat_ttl (Integer, #to_int, #to_i) 


1018
1019
1020
1021
1022
1023
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1018

def self.set_heartbeat_ttl(self_p, heartbeat_ttl)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  heartbeat_ttl = Integer(heartbeat_ttl)
  result = ::CZMQ::FFI.zsock_set_heartbeat_ttl(self_p, heartbeat_ttl)
  result
end

.set_hwm(self_p, hwm) ⇒ void

This method returns an undefined value.

Set socket option ‘hwm`. Available from libzmq 2.0.0 to 3.0.0.

This is the polymorphic version of #set_hwm.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • hwm (Integer, #to_int, #to_i) 


3686
3687
3688
3689
3690
3691
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3686

def self.set_hwm(self_p, hwm)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  hwm = Integer(hwm)
  result = ::CZMQ::FFI.zsock_set_hwm(self_p, hwm)
  result
end

.set_identity(self_p, identity) ⇒ void

This method returns an undefined value.

Set socket option ‘identity`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_identity.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • identity (String, #to_s, nil) 


3849
3850
3851
3852
3853
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3849

def self.set_identity(self_p, identity)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_identity(self_p, identity)
  result
end

.set_immediate(self_p, immediate) ⇒ void

This method returns an undefined value.

Set socket option ‘immediate`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_immediate.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • immediate (Integer, #to_int, #to_i) 


2978
2979
2980
2981
2982
2983
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2978

def self.set_immediate(self_p, immediate)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  immediate = Integer(immediate)
  result = ::CZMQ::FFI.zsock_set_immediate(self_p, immediate)
  result
end

.set_invert_matching(self_p, invert_matching) ⇒ void

This method returns an undefined value.

Set socket option ‘invert_matching`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_invert_matching.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • invert_matching (Integer, #to_int, #to_i) 


1265
1266
1267
1268
1269
1270
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1265

def self.set_invert_matching(self_p, invert_matching)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  invert_matching = Integer(invert_matching)
  result = ::CZMQ::FFI.zsock_set_invert_matching(self_p, invert_matching)
  result
end

.set_ipv4only(self_p, ipv4only) ⇒ void

This method returns an undefined value.

Set socket option ‘ipv4only`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_ipv4only.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • ipv4only (Integer, #to_int, #to_i) 


3603
3604
3605
3606
3607
3608
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3603

def self.set_ipv4only(self_p, ipv4only)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  ipv4only = Integer(ipv4only)
  result = ::CZMQ::FFI.zsock_set_ipv4only(self_p, ipv4only)
  result
end

.set_ipv6(self_p, ipv6) ⇒ void

This method returns an undefined value.

Set socket option ‘ipv6`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_ipv6.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • ipv6 (Integer, #to_int, #to_i) 


2924
2925
2926
2927
2928
2929
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2924

def self.set_ipv6(self_p, ipv6)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  ipv6 = Integer(ipv6)
  result = ::CZMQ::FFI.zsock_set_ipv6(self_p, ipv6)
  result
end

.set_linger(self_p, linger) ⇒ void

This method returns an undefined value.

Set socket option ‘linger`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_linger.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • linger (Integer, #to_int, #to_i) 


4334
4335
4336
4337
4338
4339
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4334

def self.set_linger(self_p, linger)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  linger = Integer(linger)
  result = ::CZMQ::FFI.zsock_set_linger(self_p, linger)
  result
end

.set_maxmsgsize(self_p, maxmsgsize) ⇒ void

This method returns an undefined value.

Set socket option ‘maxmsgsize`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_maxmsgsize.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • maxmsgsize (Integer, #to_int, #to_i) 


3140
3141
3142
3143
3144
3145
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3140

def self.set_maxmsgsize(self_p, maxmsgsize)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  maxmsgsize = Integer(maxmsgsize)
  result = ::CZMQ::FFI.zsock_set_maxmsgsize(self_p, maxmsgsize)
  result
end

.set_mcast_loop(self_p, mcast_loop) ⇒ void

This method returns an undefined value.

Set socket option ‘mcast_loop`. Available from libzmq 2.0.0 to 3.0.0.

This is the polymorphic version of #set_mcast_loop.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • mcast_loop (Integer, #to_int, #to_i) 


4064
4065
4066
4067
4068
4069
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4064

def self.set_mcast_loop(self_p, mcast_loop)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  mcast_loop = Integer(mcast_loop)
  result = ::CZMQ::FFI.zsock_set_mcast_loop(self_p, mcast_loop)
  result
end

.set_multicast_hops(self_p, multicast_hops) ⇒ void

This method returns an undefined value.

Set socket option ‘multicast_hops`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_multicast_hops.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • multicast_hops (Integer, #to_int, #to_i) 


3194
3195
3196
3197
3198
3199
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3194

def self.set_multicast_hops(self_p, multicast_hops)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  multicast_hops = Integer(multicast_hops)
  result = ::CZMQ::FFI.zsock_set_multicast_hops(self_p, multicast_hops)
  result
end

.set_multicast_maxtpdu(self_p, multicast_maxtpdu) ⇒ void

This method returns an undefined value.

Set socket option ‘multicast_maxtpdu`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_multicast_maxtpdu.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • multicast_maxtpdu (Integer, #to_int, #to_i) 


1481
1482
1483
1484
1485
1486
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1481

def self.set_multicast_maxtpdu(self_p, multicast_maxtpdu)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  multicast_maxtpdu = Integer(multicast_maxtpdu)
  result = ::CZMQ::FFI.zsock_set_multicast_maxtpdu(self_p, multicast_maxtpdu)
  result
end

.set_plain_password(self_p, plain_password) ⇒ void

This method returns an undefined value.

Set socket option ‘plain_password`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_plain_password.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • plain_password (String, #to_s, nil) 


2358
2359
2360
2361
2362
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2358

def self.set_plain_password(self_p, plain_password)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_plain_password(self_p, plain_password)
  result
end

.set_plain_server(self_p, plain_server) ⇒ void

This method returns an undefined value.

Set socket option ‘plain_server`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_plain_server.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • plain_server (Integer, #to_int, #to_i) 


2249
2250
2251
2252
2253
2254
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2249

def self.set_plain_server(self_p, plain_server)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  plain_server = Integer(plain_server)
  result = ::CZMQ::FFI.zsock_set_plain_server(self_p, plain_server)
  result
end

.set_plain_username(self_p, plain_username) ⇒ void

This method returns an undefined value.

Set socket option ‘plain_username`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_plain_username.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • plain_username (String, #to_s, nil) 


2304
2305
2306
2307
2308
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2304

def self.set_plain_username(self_p, plain_username)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_plain_username(self_p, plain_username)
  result
end

.set_probe_router(self_p, probe_router) ⇒ void

This method returns an undefined value.

Set socket option ‘probe_router`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_probe_router.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • probe_router (Integer, #to_int, #to_i) 


2029
2030
2031
2032
2033
2034
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2029

def self.set_probe_router(self_p, probe_router)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  probe_router = Integer(probe_router)
  result = ::CZMQ::FFI.zsock_set_probe_router(self_p, probe_router)
  result
end

.set_rate(self_p, rate) ⇒ void

This method returns an undefined value.

Set socket option ‘rate`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_rate.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • rate (Integer, #to_int, #to_i) 


3902
3903
3904
3905
3906
3907
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3902

def self.set_rate(self_p, rate)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  rate = Integer(rate)
  result = ::CZMQ::FFI.zsock_set_rate(self_p, rate)
  result
end

.set_rcvbuf(self_p, rcvbuf) ⇒ void

This method returns an undefined value.

Set socket option ‘rcvbuf`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_rcvbuf.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • rcvbuf (Integer, #to_int, #to_i) 


4280
4281
4282
4283
4284
4285
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4280

def self.set_rcvbuf(self_p, rcvbuf)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  rcvbuf = Integer(rcvbuf)
  result = ::CZMQ::FFI.zsock_set_rcvbuf(self_p, rcvbuf)
  result
end

.set_rcvhwm(self_p, rcvhwm) ⇒ void

This method returns an undefined value.

Set socket option ‘rcvhwm`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_rcvhwm.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • rcvhwm (Integer, #to_int, #to_i) 


3086
3087
3088
3089
3090
3091
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3086

def self.set_rcvhwm(self_p, rcvhwm)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  rcvhwm = Integer(rcvhwm)
  result = ::CZMQ::FFI.zsock_set_rcvhwm(self_p, rcvhwm)
  result
end

.set_rcvtimeo(self_p, rcvtimeo) ⇒ void

This method returns an undefined value.

Set socket option ‘rcvtimeo`. Available from libzmq 2.2.0.

This is the polymorphic version of #set_rcvtimeo.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • rcvtimeo (Integer, #to_int, #to_i) 


4118
4119
4120
4121
4122
4123
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4118

def self.set_rcvtimeo(self_p, rcvtimeo)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  rcvtimeo = Integer(rcvtimeo)
  result = ::CZMQ::FFI.zsock_set_rcvtimeo(self_p, rcvtimeo)
  result
end

.set_reconnect_ivl(self_p, reconnect_ivl) ⇒ void

This method returns an undefined value.

Set socket option ‘reconnect_ivl`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_reconnect_ivl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • reconnect_ivl (Integer, #to_int, #to_i) 


4388
4389
4390
4391
4392
4393
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4388

def self.set_reconnect_ivl(self_p, reconnect_ivl)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  reconnect_ivl = Integer(reconnect_ivl)
  result = ::CZMQ::FFI.zsock_set_reconnect_ivl(self_p, reconnect_ivl)
  result
end

.set_reconnect_ivl_max(self_p, reconnect_ivl_max) ⇒ void

This method returns an undefined value.

Set socket option ‘reconnect_ivl_max`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_reconnect_ivl_max.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • reconnect_ivl_max (Integer, #to_int, #to_i) 


4442
4443
4444
4445
4446
4447
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4442

def self.set_reconnect_ivl_max(self_p, reconnect_ivl_max)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  reconnect_ivl_max = Integer(reconnect_ivl_max)
  result = ::CZMQ::FFI.zsock_set_reconnect_ivl_max(self_p, reconnect_ivl_max)
  result
end

.set_recovery_ivl(self_p, recovery_ivl) ⇒ void

This method returns an undefined value.

Set socket option ‘recovery_ivl`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_recovery_ivl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • recovery_ivl (Integer, #to_int, #to_i) 


3956
3957
3958
3959
3960
3961
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3956

def self.set_recovery_ivl(self_p, recovery_ivl)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  recovery_ivl = Integer(recovery_ivl)
  result = ::CZMQ::FFI.zsock_set_recovery_ivl(self_p, recovery_ivl)
  result
end

.set_recovery_ivl_msec(self_p, recovery_ivl_msec) ⇒ void

This method returns an undefined value.

Set socket option ‘recovery_ivl_msec`. Available from libzmq 2.0.0 to 3.0.0.

This is the polymorphic version of #set_recovery_ivl_msec.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • recovery_ivl_msec (Integer, #to_int, #to_i) 


4010
4011
4012
4013
4014
4015
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4010

def self.set_recovery_ivl_msec(self_p, recovery_ivl_msec)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  recovery_ivl_msec = Integer(recovery_ivl_msec)
  result = ::CZMQ::FFI.zsock_set_recovery_ivl_msec(self_p, recovery_ivl_msec)
  result
end

.set_req_correlate(self_p, req_correlate) ⇒ void

This method returns an undefined value.

Set socket option ‘req_correlate`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_req_correlate.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • req_correlate (Integer, #to_int, #to_i) 


2087
2088
2089
2090
2091
2092
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2087

def self.set_req_correlate(self_p, req_correlate)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  req_correlate = Integer(req_correlate)
  result = ::CZMQ::FFI.zsock_set_req_correlate(self_p, req_correlate)
  result
end

.set_req_relaxed(self_p, req_relaxed) ⇒ void

This method returns an undefined value.

Set socket option ‘req_relaxed`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_req_relaxed.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • req_relaxed (Integer, #to_int, #to_i) 


2058
2059
2060
2061
2062
2063
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2058

def self.set_req_relaxed(self_p, req_relaxed)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  req_relaxed = Integer(req_relaxed)
  result = ::CZMQ::FFI.zsock_set_req_relaxed(self_p, req_relaxed)
  result
end

.set_router_handover(self_p, router_handover) ⇒ void

This method returns an undefined value.

Set socket option ‘router_handover`. Available from libzmq 4.1.0.

This is the polymorphic version of #set_router_handover.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • router_handover (Integer, #to_int, #to_i) 


1780
1781
1782
1783
1784
1785
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1780

def self.set_router_handover(self_p, router_handover)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  router_handover = Integer(router_handover)
  result = ::CZMQ::FFI.zsock_set_router_handover(self_p, router_handover)
  result
end

.set_router_mandatory(self_p, router_mandatory) ⇒ void

This method returns an undefined value.

Set socket option ‘router_mandatory`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_router_mandatory.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • router_mandatory (Integer, #to_int, #to_i) 


2000
2001
2002
2003
2004
2005
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2000

def self.set_router_mandatory(self_p, router_mandatory)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  router_mandatory = Integer(router_mandatory)
  result = ::CZMQ::FFI.zsock_set_router_mandatory(self_p, router_mandatory)
  result
end

.set_router_raw(self_p, router_raw) ⇒ void

This method returns an undefined value.

Set socket option ‘router_raw`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_router_raw.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • router_raw (Integer, #to_int, #to_i) 


3549
3550
3551
3552
3553
3554
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3549

def self.set_router_raw(self_p, router_raw)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  router_raw = Integer(router_raw)
  result = ::CZMQ::FFI.zsock_set_router_raw(self_p, router_raw)
  result
end

.set_sndbuf(self_p, sndbuf) ⇒ void

This method returns an undefined value.

Set socket option ‘sndbuf`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_sndbuf.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • sndbuf (Integer, #to_int, #to_i) 


4226
4227
4228
4229
4230
4231
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4226

def self.set_sndbuf(self_p, sndbuf)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  sndbuf = Integer(sndbuf)
  result = ::CZMQ::FFI.zsock_set_sndbuf(self_p, sndbuf)
  result
end

.set_sndhwm(self_p, sndhwm) ⇒ void

This method returns an undefined value.

Set socket option ‘sndhwm`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_sndhwm.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • sndhwm (Integer, #to_int, #to_i) 


3032
3033
3034
3035
3036
3037
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3032

def self.set_sndhwm(self_p, sndhwm)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  sndhwm = Integer(sndhwm)
  result = ::CZMQ::FFI.zsock_set_sndhwm(self_p, sndhwm)
  result
end

.set_sndtimeo(self_p, sndtimeo) ⇒ void

This method returns an undefined value.

Set socket option ‘sndtimeo`. Available from libzmq 2.2.0.

This is the polymorphic version of #set_sndtimeo.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • sndtimeo (Integer, #to_int, #to_i) 


4172
4173
4174
4175
4176
4177
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4172

def self.set_sndtimeo(self_p, sndtimeo)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  sndtimeo = Integer(sndtimeo)
  result = ::CZMQ::FFI.zsock_set_sndtimeo(self_p, sndtimeo)
  result
end

.set_socks_proxy(self_p, socks_proxy) ⇒ void

This method returns an undefined value.

Set socket option ‘socks_proxy`. Available from libzmq 4.1.0.

This is the polymorphic version of #set_socks_proxy.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • socks_proxy (String, #to_s, nil) 


1943
1944
1945
1946
1947
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1943

def self.set_socks_proxy(self_p, socks_proxy)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_socks_proxy(self_p, socks_proxy)
  result
end

.set_stream_notify(self_p, stream_notify) ⇒ void

This method returns an undefined value.

Set socket option ‘stream_notify`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_stream_notify.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • stream_notify (Integer, #to_int, #to_i) 


1211
1212
1213
1214
1215
1216
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1211

def self.set_stream_notify(self_p, stream_notify)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  stream_notify = Integer(stream_notify)
  result = ::CZMQ::FFI.zsock_set_stream_notify(self_p, stream_notify)
  result
end

.set_subscribe(self_p, subscribe) ⇒ void

This method returns an undefined value.

Set socket option ‘subscribe`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_subscribe.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • subscribe (String, #to_s, nil) 


4524
4525
4526
4527
4528
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4524

def self.set_subscribe(self_p, subscribe)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_subscribe(self_p, subscribe)
  result
end

.set_swap(self_p, swap) ⇒ void

This method returns an undefined value.

Set socket option ‘swap`. Available from libzmq 2.0.0 to 3.0.0.

This is the polymorphic version of #set_swap.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • swap (Integer, #to_int, #to_i) 


3740
3741
3742
3743
3744
3745
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3740

def self.set_swap(self_p, swap)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  swap = Integer(swap)
  result = ::CZMQ::FFI.zsock_set_swap(self_p, swap)
  result
end

.set_tcp_accept_filter(self_p, tcp_accept_filter) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_accept_filter`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_tcp_accept_filter.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • tcp_accept_filter (String, #to_s, nil) 


3494
3495
3496
3497
3498
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3494

def self.set_tcp_accept_filter(self_p, tcp_accept_filter)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_tcp_accept_filter(self_p, tcp_accept_filter)
  result
end

.set_tcp_keepalive(self_p, tcp_keepalive) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_keepalive`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_tcp_keepalive.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • tcp_keepalive (Integer, #to_int, #to_i) 


3277
3278
3279
3280
3281
3282
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3277

def self.set_tcp_keepalive(self_p, tcp_keepalive)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  tcp_keepalive = Integer(tcp_keepalive)
  result = ::CZMQ::FFI.zsock_set_tcp_keepalive(self_p, tcp_keepalive)
  result
end

.set_tcp_keepalive_cnt(self_p, tcp_keepalive_cnt) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_keepalive_cnt`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_tcp_keepalive_cnt.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • tcp_keepalive_cnt (Integer, #to_int, #to_i) 


3385
3386
3387
3388
3389
3390
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3385

def self.set_tcp_keepalive_cnt(self_p, tcp_keepalive_cnt)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  tcp_keepalive_cnt = Integer(tcp_keepalive_cnt)
  result = ::CZMQ::FFI.zsock_set_tcp_keepalive_cnt(self_p, tcp_keepalive_cnt)
  result
end

.set_tcp_keepalive_idle(self_p, tcp_keepalive_idle) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_keepalive_idle`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_tcp_keepalive_idle.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • tcp_keepalive_idle (Integer, #to_int, #to_i) 


3331
3332
3333
3334
3335
3336
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3331

def self.set_tcp_keepalive_idle(self_p, tcp_keepalive_idle)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  tcp_keepalive_idle = Integer(tcp_keepalive_idle)
  result = ::CZMQ::FFI.zsock_set_tcp_keepalive_idle(self_p, tcp_keepalive_idle)
  result
end

.set_tcp_keepalive_intvl(self_p, tcp_keepalive_intvl) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_keepalive_intvl`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_tcp_keepalive_intvl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • tcp_keepalive_intvl (Integer, #to_int, #to_i) 


3439
3440
3441
3442
3443
3444
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3439

def self.set_tcp_keepalive_intvl(self_p, tcp_keepalive_intvl)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  tcp_keepalive_intvl = Integer(tcp_keepalive_intvl)
  result = ::CZMQ::FFI.zsock_set_tcp_keepalive_intvl(self_p, tcp_keepalive_intvl)
  result
end

.set_tcp_maxrt(self_p, tcp_maxrt) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_maxrt`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_tcp_maxrt.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • tcp_maxrt (Integer, #to_int, #to_i) 


1402
1403
1404
1405
1406
1407
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1402

def self.set_tcp_maxrt(self_p, tcp_maxrt)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  tcp_maxrt = Integer(tcp_maxrt)
  result = ::CZMQ::FFI.zsock_set_tcp_maxrt(self_p, tcp_maxrt)
  result
end

.set_tos(self_p, tos) ⇒ void

This method returns an undefined value.

Set socket option ‘tos`. Available from libzmq 4.1.0.

This is the polymorphic version of #set_tos.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • tos (Integer, #to_int, #to_i) 


1751
1752
1753
1754
1755
1756
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1751

def self.set_tos(self_p, tos)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  tos = Integer(tos)
  result = ::CZMQ::FFI.zsock_set_tos(self_p, tos)
  result
end

.set_unbounded(self_p) ⇒ void

This method returns an undefined value.

Set socket to use unbounded pipes (HWM=0); use this in cases when you are totally certain the message volume can fit in memory. This method works across all versions of ZeroMQ. Takes a polymorphic socket reference.

This is the polymorphic version of #set_unbounded.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on



744
745
746
747
748
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 744

def self.set_unbounded(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_unbounded(self_p)
  result
end

.set_unsubscribe(self_p, unsubscribe) ⇒ void

This method returns an undefined value.

Set socket option ‘unsubscribe`. Available from libzmq 2.0.0.

This is the polymorphic version of #set_unsubscribe.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • unsubscribe (String, #to_s, nil) 


4551
4552
4553
4554
4555
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4551

def self.set_unsubscribe(self_p, unsubscribe)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_unsubscribe(self_p, unsubscribe)
  result
end

.set_use_fd(self_p, use_fd) ⇒ void

This method returns an undefined value.

Set socket option ‘use_fd`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_use_fd.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • use_fd (Integer, #to_int, #to_i) 


1126
1127
1128
1129
1130
1131
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1126

def self.set_use_fd(self_p, use_fd)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  use_fd = Integer(use_fd)
  result = ::CZMQ::FFI.zsock_set_use_fd(self_p, use_fd)
  result
end

.set_vmci_buffer_max_size(self_p, vmci_buffer_max_size) ⇒ void

This method returns an undefined value.

Set socket option ‘vmci_buffer_max_size`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_vmci_buffer_max_size.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • vmci_buffer_max_size (Integer, #to_int, #to_i) 


1643
1644
1645
1646
1647
1648
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1643

def self.set_vmci_buffer_max_size(self_p, vmci_buffer_max_size)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  vmci_buffer_max_size = Integer(vmci_buffer_max_size)
  result = ::CZMQ::FFI.zsock_set_vmci_buffer_max_size(self_p, vmci_buffer_max_size)
  result
end

.set_vmci_buffer_min_size(self_p, vmci_buffer_min_size) ⇒ void

This method returns an undefined value.

Set socket option ‘vmci_buffer_min_size`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_vmci_buffer_min_size.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • vmci_buffer_min_size (Integer, #to_int, #to_i) 


1589
1590
1591
1592
1593
1594
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1589

def self.set_vmci_buffer_min_size(self_p, vmci_buffer_min_size)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  vmci_buffer_min_size = Integer(vmci_buffer_min_size)
  result = ::CZMQ::FFI.zsock_set_vmci_buffer_min_size(self_p, vmci_buffer_min_size)
  result
end

.set_vmci_buffer_size(self_p, vmci_buffer_size) ⇒ void

This method returns an undefined value.

Set socket option ‘vmci_buffer_size`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_vmci_buffer_size.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • vmci_buffer_size (Integer, #to_int, #to_i) 


1535
1536
1537
1538
1539
1540
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1535

def self.set_vmci_buffer_size(self_p, vmci_buffer_size)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  vmci_buffer_size = Integer(vmci_buffer_size)
  result = ::CZMQ::FFI.zsock_set_vmci_buffer_size(self_p, vmci_buffer_size)
  result
end

.set_vmci_connect_timeout(self_p, vmci_connect_timeout) ⇒ void

This method returns an undefined value.

Set socket option ‘vmci_connect_timeout`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_vmci_connect_timeout.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • vmci_connect_timeout (Integer, #to_int, #to_i) 


1697
1698
1699
1700
1701
1702
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1697

def self.set_vmci_connect_timeout(self_p, vmci_connect_timeout)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  vmci_connect_timeout = Integer(vmci_connect_timeout)
  result = ::CZMQ::FFI.zsock_set_vmci_connect_timeout(self_p, vmci_connect_timeout)
  result
end

.set_xpub_manual(self_p, xpub_manual) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_manual`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_xpub_manual.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • xpub_manual (Integer, #to_int, #to_i) 


1155
1156
1157
1158
1159
1160
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1155

def self.set_xpub_manual(self_p, xpub_manual)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  xpub_manual = Integer(xpub_manual)
  result = ::CZMQ::FFI.zsock_set_xpub_manual(self_p, xpub_manual)
  result
end

.set_xpub_nodrop(self_p, xpub_nodrop) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_nodrop`. Available from libzmq 4.1.0.

This is the polymorphic version of #set_xpub_nodrop.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • xpub_nodrop (Integer, #to_int, #to_i) 


1971
1972
1973
1974
1975
1976
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1971

def self.set_xpub_nodrop(self_p, xpub_nodrop)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  xpub_nodrop = Integer(xpub_nodrop)
  result = ::CZMQ::FFI.zsock_set_xpub_nodrop(self_p, xpub_nodrop)
  result
end

.set_xpub_verbose(self_p, xpub_verbose) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_verbose`. Available from libzmq 3.0.0.

This is the polymorphic version of #set_xpub_verbose.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • xpub_verbose (Integer, #to_int, #to_i) 


3223
3224
3225
3226
3227
3228
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3223

def self.set_xpub_verbose(self_p, xpub_verbose)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  xpub_verbose = Integer(xpub_verbose)
  result = ::CZMQ::FFI.zsock_set_xpub_verbose(self_p, xpub_verbose)
  result
end

.set_xpub_verboser(self_p, xpub_verboser) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_verboser`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_xpub_verboser.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • xpub_verboser (Integer, #to_int, #to_i) 


1294
1295
1296
1297
1298
1299
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1294

def self.set_xpub_verboser(self_p, xpub_verboser)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  xpub_verboser = Integer(xpub_verboser)
  result = ::CZMQ::FFI.zsock_set_xpub_verboser(self_p, xpub_verboser)
  result
end

.set_xpub_welcome_msg(self_p, xpub_welcome_msg) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_welcome_msg`. Available from libzmq 4.2.0.

This is the polymorphic version of #set_xpub_welcome_msg.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • xpub_welcome_msg (String, #to_s, nil) 


1183
1184
1185
1186
1187
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1183

def self.set_xpub_welcome_msg(self_p, xpub_welcome_msg)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_xpub_welcome_msg(self_p, xpub_welcome_msg)
  result
end

.set_zap_domain(self_p, zap_domain) ⇒ void

This method returns an undefined value.

Set socket option ‘zap_domain`. Available from libzmq 4.0.0.

This is the polymorphic version of #set_zap_domain.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • zap_domain (String, #to_s, nil) 


2171
2172
2173
2174
2175
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2171

def self.set_zap_domain(self_p, zap_domain)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_zap_domain(self_p, zap_domain)
  result
end

.signal(self_p, status) ⇒ Integer

Send a signal over a socket. A signal is a short message carrying a success/failure code (by convention, 0 means OK). Signals are encoded to be distinguishable from “normal” messages. Accepts a zsock_t or a zactor_t argument, and returns 0 if successful, -1 if the signal could not be sent. Takes a polymorphic socket reference.

This is the polymorphic version of #signal.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • status (Integer, #to_int, #to_i)

Returns:

  • (Integer) 


778
779
780
781
782
783
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 778

def self.signal(self_p, status)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  status = Integer(status)
  result = ::CZMQ::FFI.zsock_signal(self_p, status)
  result
end

.sndbuf(self_p) ⇒ Integer

Get socket option ‘sndbuf`. Available from libzmq 2.0.0.

This is the polymorphic version of #sndbuf.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4198
4199
4200
4201
4202
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4198

def self.sndbuf(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_sndbuf(self_p)
  result
end

.sndhwm(self_p) ⇒ Integer

Get socket option ‘sndhwm`. Available from libzmq 3.0.0.

This is the polymorphic version of #sndhwm.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3004
3005
3006
3007
3008
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3004

def self.sndhwm(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_sndhwm(self_p)
  result
end

.sndtimeo(self_p) ⇒ Integer

Get socket option ‘sndtimeo`. Available from libzmq 2.2.0.

This is the polymorphic version of #sndtimeo.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4144
4145
4146
4147
4148
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4144

def self.sndtimeo(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_sndtimeo(self_p)
  result
end

.socks_proxy(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘socks_proxy`. Available from libzmq 4.1.0.

This is the polymorphic version of #socks_proxy.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


1915
1916
1917
1918
1919
1920
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1915

def self.socks_proxy(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_socks_proxy(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

.swap(self_p) ⇒ Integer

Get socket option ‘swap`. Available from libzmq 2.0.0 to 3.0.0.

This is the polymorphic version of #swap.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3712
3713
3714
3715
3716
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3712

def self.swap(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_swap(self_p)
  result
end

.tcp_accept_filter(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘tcp_accept_filter`. Available from libzmq 3.0.0.

This is the polymorphic version of #tcp_accept_filter.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


3466
3467
3468
3469
3470
3471
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3466

def self.tcp_accept_filter(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_tcp_accept_filter(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

.tcp_keepalive(self_p) ⇒ Integer

Get socket option ‘tcp_keepalive`. Available from libzmq 3.0.0.

This is the polymorphic version of #tcp_keepalive.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3249
3250
3251
3252
3253
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3249

def self.tcp_keepalive(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_tcp_keepalive(self_p)
  result
end

.tcp_keepalive_cnt(self_p) ⇒ Integer

Get socket option ‘tcp_keepalive_cnt`. Available from libzmq 3.0.0.

This is the polymorphic version of #tcp_keepalive_cnt.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3357
3358
3359
3360
3361
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3357

def self.tcp_keepalive_cnt(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_tcp_keepalive_cnt(self_p)
  result
end

.tcp_keepalive_idle(self_p) ⇒ Integer

Get socket option ‘tcp_keepalive_idle`. Available from libzmq 3.0.0.

This is the polymorphic version of #tcp_keepalive_idle.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3303
3304
3305
3306
3307
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3303

def self.tcp_keepalive_idle(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_tcp_keepalive_idle(self_p)
  result
end

.tcp_keepalive_intvl(self_p) ⇒ Integer

Get socket option ‘tcp_keepalive_intvl`. Available from libzmq 3.0.0.

This is the polymorphic version of #tcp_keepalive_intvl.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


3411
3412
3413
3414
3415
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3411

def self.tcp_keepalive_intvl(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_tcp_keepalive_intvl(self_p)
  result
end

.tcp_maxrt(self_p) ⇒ Integer

Get socket option ‘tcp_maxrt`. Available from libzmq 4.2.0.

This is the polymorphic version of #tcp_maxrt.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1374
1375
1376
1377
1378
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1374

def self.tcp_maxrt(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_tcp_maxrt(self_p)
  result
end

.test(verbose) ⇒ void

This method returns an undefined value.

Self test of this class.

Parameters:

  • verbose (Boolean) 


4661
4662
4663
4664
4665
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4661

def self.test(verbose)
  verbose = !(0==verbose||!verbose) # boolean
  result = ::CZMQ::FFI.zsock_test(verbose)
  result
end

.thread_safe(self_p) ⇒ Integer

Get socket option ‘thread_safe`. Available from libzmq 4.2.0.

This is the polymorphic version of #thread_safe.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1428
1429
1430
1431
1432
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1428

def self.thread_safe(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_thread_safe(self_p)
  result
end

.tos(self_p) ⇒ Integer

Get socket option ‘tos`. Available from libzmq 4.1.0.

This is the polymorphic version of #tos.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1723
1724
1725
1726
1727
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1723

def self.tos(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_tos(self_p)
  result
end

.type(self_p) ⇒ Integer

Get socket option ‘type`. Available from libzmq 2.0.0.

This is the polymorphic version of #type.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


4576
4577
4578
4579
4580
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4576

def self.type(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_type(self_p)
  result
end

.use_fd(self_p) ⇒ Integer

Get socket option ‘use_fd`. Available from libzmq 4.2.0.

This is the polymorphic version of #use_fd.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1098
1099
1100
1101
1102
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1098

def self.use_fd(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_use_fd(self_p)
  result
end

.vmci_buffer_max_size(self_p) ⇒ Integer

Get socket option ‘vmci_buffer_max_size`. Available from libzmq 4.2.0.

This is the polymorphic version of #vmci_buffer_max_size.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1615
1616
1617
1618
1619
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1615

def self.vmci_buffer_max_size(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_vmci_buffer_max_size(self_p)
  result
end

.vmci_buffer_min_size(self_p) ⇒ Integer

Get socket option ‘vmci_buffer_min_size`. Available from libzmq 4.2.0.

This is the polymorphic version of #vmci_buffer_min_size.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1561
1562
1563
1564
1565
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1561

def self.vmci_buffer_min_size(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_vmci_buffer_min_size(self_p)
  result
end

.vmci_buffer_size(self_p) ⇒ Integer

Get socket option ‘vmci_buffer_size`. Available from libzmq 4.2.0.

This is the polymorphic version of #vmci_buffer_size.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1507
1508
1509
1510
1511
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1507

def self.vmci_buffer_size(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_vmci_buffer_size(self_p)
  result
end

.vmci_connect_timeout(self_p) ⇒ Integer

Get socket option ‘vmci_connect_timeout`. Available from libzmq 4.2.0.

This is the polymorphic version of #vmci_connect_timeout.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


1669
1670
1671
1672
1673
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1669

def self.vmci_connect_timeout(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_vmci_connect_timeout(self_p)
  result
end

.vrecv(self_p, picture, argptr) ⇒ Integer

Receive a ‘picture’ message from the socket (or actor). This is a va_list version of zsock_recv (), so please consult its documentation for the details.

This is the polymorphic version of #vrecv.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • picture (String, #to_s, nil)
  • argptr (::FFI::Pointer, #to_ptr)

Returns:

  • (Integer) 


567
568
569
570
571
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 567

def self.vrecv(self_p, picture, argptr)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_vrecv(self_p, picture, argptr)
  result
end

.vsend(self_p, picture, argptr) ⇒ Integer

Send a ‘picture’ message to the socket (or actor). This is a va_list version of zsock_send (), so please consult its documentation for the details.

This is the polymorphic version of #vsend.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

  • picture (String, #to_s, nil)
  • argptr (::FFI::Pointer, #to_ptr)

Returns:

  • (Integer) 


459
460
461
462
463
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 459

def self.vsend(self_p, picture, argptr)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_vsend(self_p, picture, argptr)
  result
end

.wait(self_p) ⇒ Integer

Wait on a signal. Use this to coordinate between threads, over pipe pairs. Blocks until the signal is received. Returns -1 on error, 0 or greater on success. Accepts a zsock_t or a zactor_t as argument. Takes a polymorphic socket reference.

This is the polymorphic version of #wait.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (Integer) 


808
809
810
811
812
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 808

def self.wait(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_wait(self_p)
  result
end

.zap_domain(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘zap_domain`. Available from libzmq 4.0.0.

This is the polymorphic version of #zap_domain.

Parameters:

  • self_p (CZMQ::Zsock, #__ptr, ::FFI::Pointer, nil) —

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer) 


2143
2144
2145
2146
2147
2148
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2143

def self.zap_domain(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_zap_domain(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

Instance Method Details

#__ptr ⇒ ::FFI::Pointer Also known as: to_ptr

Return internal pointer

Returns:

  • (::FFI::Pointer)

Raises:



48
49
50
51
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 48

def __ptr
  raise DestroyedError unless @ptr
  @ptr
end

#__ptr_give_ref ⇒ ::FFI::MemoryPointer

Note:

This detaches the current instance from the native object and thus makes it unusable.

Nullify internal pointer and return pointer pointer.

Returns:

  • (::FFI::MemoryPointer) —

    the pointer pointing to a pointer pointing to the native object

Raises:



59
60
61
62
63
64
65
66
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 59

def __ptr_give_ref
  raise DestroyedError unless @ptr
  ptr_ptr = ::FFI::MemoryPointer.new :pointer
  ptr_ptr.write_pointer @ptr
  __undef_finalizer if @finalizer
  @ptr = nil
  ptr_ptr
end

#__undef_finalizer ⇒ void

Note:

Only use this if you need to and can guarantee that the native object will be freed by other means.

This method returns an undefined value.

Undefines the finalizer for this object.



71
72
73
74
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 71

def __undef_finalizer
  ObjectSpace.undefine_finalizer self
  @finalizer = nil
end

#affinity ⇒ Integer

Get socket option ‘affinity`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



3751
3752
3753
3754
3755
3756
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3751

def affinity()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_affinity(self_p)
  result
end

#attach(endpoints, serverish) ⇒ Integer

Attach a socket to zero or more endpoints. If endpoints is not null, parses as list of ZeroMQ endpoints, separated by commas, and prefixed by ‘@’ (to bind the socket) or ‘>’ (to connect the socket). Returns 0 if all endpoints were valid, or -1 if there was a syntax error. If the endpoint does not start with ‘@’ or ‘>’, the serverish argument defines whether it is used to bind (serverish = true) or connect (serverish = false).

Parameters:

  • endpoints (String, #to_s, nil)
  • serverish (Boolean)

Returns:

  • (Integer)

Raises:



339
340
341
342
343
344
345
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 339

def attach(endpoints, serverish)
  raise DestroyedError unless @ptr
  self_p = @ptr
  serverish = !(0==serverish||!serverish) # boolean
  result = ::CZMQ::FFI.zsock_attach(self_p, endpoints, serverish)
  result
end

#backlog ⇒ Integer

Get socket option ‘backlog`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



4453
4454
4455
4456
4457
4458
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4453

def backlog()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_backlog(self_p)
  result
end

#bind(format, *args) ⇒ Integer

Bind a socket to a formatted endpoint. For tcp:// endpoints, supports ephemeral ports, if you specify the port number as “*”. By default zsock uses the IANA designated range from C000 (49152) to FFFF (65535). To override this range, follow the “*” with “[first-last]”. Either or both first and last may be empty. To bind to a random port within the range, use “!” in place of “*”.

Examples:

tcp://127.0.0.1:*           bind to first free port from C000 up
tcp://127.0.0.1:!           bind to random port from C000 to FFFF
tcp://127.0.0.1:*[60000-]   bind to first free port from 60000 up
tcp://127.0.0.1:![-60000]   bind to random port from C000 to 60000
tcp://127.0.0.1:![55000-55999]
                            bind to random port from 55000 to 55999

On success, returns the actual port number used, for tcp:// endpoints, and 0 for other transports. On failure, returns -1. Note that when using ephemeral ports, a port may be reused by different services without clients being aware. Protocols that run on ephemeral ports should take this into account.

Parameters:

Returns:

  • (Integer)

Raises:



271
272
273
274
275
276
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 271

def bind(format, *args)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_bind(self_p, format, *args)
  result
end

#brecv(picture, *args) ⇒ Integer

Receive a binary encoded ‘picture’ message from the socket (or actor). This method is similar to zsock_recv, except the arguments are encoded in a binary format that is compatible with zproto, and is designed to reduce memory allocations. The pattern argument is a string that defines the type of each argument. See zsock_bsend for the supported argument types. All arguments must be pointers; this call sets them to point to values held on a per-socket basis. For types 1, 2, 4 and 8 the caller must allocate the memory itself before calling zsock_brecv. For types S, the caller must free the value once finished with it, as zsock_brecv will allocate the buffer. For type s, the caller must not free the value as it is stored in a local cache for performance purposes. For types c, f, u and m the caller must call the appropriate destructor depending on the object as zsock_brecv will create new objects. For type p the caller must coordinate with the sender, as it is just a pointer value being passed.

Parameters:

Returns:

  • (Integer)

Raises:



661
662
663
664
665
666
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 661

def brecv(picture, *args)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_brecv(self_p, picture, *args)
  result
end

#bsend(picture, *args) ⇒ Integer

Send a binary encoded ‘picture’ message to the socket (or actor). This method is similar to zsock_send, except the arguments are encoded in a binary format that is compatible with zproto, and is designed to reduce memory allocations. The pattern argument is a string that defines the type of each argument. Supports these argument types:

pattern    C type                  zproto type:
   1       uint8_t                 type = "number" size = "1"
   2       uint16_t                type = "number" size = "2"
   4       uint32_t                type = "number" size = "3"
   8       uint64_t                type = "number" size = "4"
   s       char *, 0-255 chars     type = "string"
   S       char *, 0-2^32-1 chars  type = "longstr"
   c       zchunk_t *              type = "chunk"
   f       zframe_t *              type = "frame"
   u       zuuid_t *               type = "uuid"
   m       zmsg_t *                type = "msg"
   p       void *, sends pointer value, only over inproc

Does not change or take ownership of any arguments. Returns 0 if successful, -1 if sending failed for any reason.

Parameters:

Returns:

  • (Integer)

Raises:



598
599
600
601
602
603
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 598

def bsend(picture, *args)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_bsend(self_p, picture, *args)
  result
end

#connect(format, *args) ⇒ Integer

Connect a socket to a formatted endpoint Returns 0 if OK, -1 if the endpoint was invalid.

Parameters:

Returns:

  • (Integer)

Raises:



308
309
310
311
312
313
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 308

def connect(format, *args)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_connect(self_p, format, *args)
  result
end

#connect_timeout ⇒ Integer

Get socket option ‘connect_timeout`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



1305
1306
1307
1308
1309
1310
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1305

def connect_timeout()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_connect_timeout(self_p)
  result
end

#curve_publickey ⇒ ::FFI::AutoPointer

Get socket option ‘curve_publickey`. Available from libzmq 4.0.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



2422
2423
2424
2425
2426
2427
2428
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2422

def curve_publickey()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_curve_publickey(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

#curve_secretkey ⇒ ::FFI::AutoPointer

Get socket option ‘curve_secretkey`. Available from libzmq 4.0.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



2503
2504
2505
2506
2507
2508
2509
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2503

def curve_secretkey()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_curve_secretkey(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

#curve_server ⇒ Integer

Get socket option ‘curve_server`. Available from libzmq 4.0.0.

Returns:

  • (Integer)

Raises:



2368
2369
2370
2371
2372
2373
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2368

def curve_server()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_curve_server(self_p)
  result
end

#curve_serverkey ⇒ ::FFI::AutoPointer

Get socket option ‘curve_serverkey`. Available from libzmq 4.0.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



2584
2585
2586
2587
2588
2589
2590
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2584

def curve_serverkey()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_curve_serverkey(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

#destroy ⇒ void

This method returns an undefined value.

Destroy the socket. You must use this for any socket created via the zsock_new method.



240
241
242
243
244
245
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 240

def destroy()
  return unless @ptr
  self_p = __ptr_give_ref
  result = ::CZMQ::FFI.zsock_destroy(self_p)
  result
end

#disconnect(format, *args) ⇒ Integer

Disconnect a socket from a formatted endpoint Returns 0 if OK, -1 if the endpoint was invalid or the function isn’t supported.

Parameters:

Returns:

  • (Integer)

Raises:



322
323
324
325
326
327
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 322

def disconnect(format, *args)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_disconnect(self_p, format, *args)
  result
end

#endpoint ⇒ String

Returns last bound endpoint, if any.

Returns:

  • (String)

Raises:



281
282
283
284
285
286
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 281

def endpoint()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_endpoint(self_p)
  result
end

#events ⇒ Integer

Get socket option ‘events`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



4636
4637
4638
4639
4640
4641
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4636

def events()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_events(self_p)
  result
end

#fd ⇒ Integer or FFI::Pointer

Get socket option ‘fd`. Available from libzmq 2.0.0.

Returns:

  • (Integer or FFI::Pointer)

Raises:



4611
4612
4613
4614
4615
4616
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4611

def fd()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_fd(self_p)
  result
end

#flush ⇒ void

This method returns an undefined value.

If there is a partial message still waiting on the socket, remove and discard it. This is useful when reading partial messages, to get specific message types.

Raises:



819
820
821
822
823
824
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 819

def flush()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_flush(self_p)
  result
end

#gssapi_plaintext ⇒ Integer

Get socket option ‘gssapi_plaintext`. Available from libzmq 4.0.0.

Returns:

  • (Integer)

Raises:



2719
2720
2721
2722
2723
2724
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2719

def gssapi_plaintext()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_gssapi_plaintext(self_p)
  result
end

#gssapi_principal ⇒ ::FFI::AutoPointer

Get socket option ‘gssapi_principal`. Available from libzmq 4.0.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



2773
2774
2775
2776
2777
2778
2779
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2773

def gssapi_principal()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_gssapi_principal(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

#gssapi_server ⇒ Integer

Get socket option ‘gssapi_server`. Available from libzmq 4.0.0.

Returns:

  • (Integer)

Raises:



2665
2666
2667
2668
2669
2670
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2665

def gssapi_server()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_gssapi_server(self_p)
  result
end

#gssapi_service_principal ⇒ ::FFI::AutoPointer

Get socket option ‘gssapi_service_principal`. Available from libzmq 4.0.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



2827
2828
2829
2830
2831
2832
2833
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2827

def gssapi_service_principal()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_gssapi_service_principal(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

#handshake_ivl ⇒ Integer

Get socket option ‘handshake_ivl`. Available from libzmq 4.1.0.

Returns:

  • (Integer)

Raises:



1845
1846
1847
1848
1849
1850
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1845

def handshake_ivl()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_handshake_ivl(self_p)
  result
end

#heartbeat_ivl ⇒ Integer

Get socket option ‘heartbeat_ivl`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



921
922
923
924
925
926
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 921

def heartbeat_ivl()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_heartbeat_ivl(self_p)
  result
end

#heartbeat_timeout ⇒ Integer

Get socket option ‘heartbeat_timeout`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



1029
1030
1031
1032
1033
1034
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1029

def heartbeat_timeout()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_heartbeat_timeout(self_p)
  result
end

#heartbeat_ttl ⇒ Integer

Get socket option ‘heartbeat_ttl`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



975
976
977
978
979
980
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 975

def heartbeat_ttl()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_heartbeat_ttl(self_p)
  result
end

#hwm ⇒ Integer

Get socket option ‘hwm`. Available from libzmq 2.0.0 to 3.0.0.

Returns:

  • (Integer)

Raises:



3643
3644
3645
3646
3647
3648
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3643

def hwm()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_hwm(self_p)
  result
end

#identity ⇒ ::FFI::AutoPointer

Get socket option ‘identity`. Available from libzmq 2.0.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



3805
3806
3807
3808
3809
3810
3811
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3805

def identity()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_identity(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

#immediate ⇒ Integer

Get socket option ‘immediate`. Available from libzmq 4.0.0.

Returns:

  • (Integer)

Raises:



2935
2936
2937
2938
2939
2940
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2935

def immediate()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_immediate(self_p)
  result
end

#invert_matching ⇒ Integer

Get socket option ‘invert_matching`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



1222
1223
1224
1225
1226
1227
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1222

def invert_matching()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_invert_matching(self_p)
  result
end

#ipv4only ⇒ Integer

Get socket option ‘ipv4only`. Available from libzmq 3.0.0.

Returns:

  • (Integer)

Raises:



3560
3561
3562
3563
3564
3565
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3560

def ipv4only()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_ipv4only(self_p)
  result
end

#ipv6 ⇒ Integer

Get socket option ‘ipv6`. Available from libzmq 4.0.0.

Returns:

  • (Integer)

Raises:



2881
2882
2883
2884
2885
2886
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2881

def ipv6()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_ipv6(self_p)
  result
end

#join(group) ⇒ Integer

Join a group for the RADIO-DISH pattern. Call only on ZMQ_DISH. Returns 0 if OK, -1 if failed.

Parameters:

  • group (String, #to_s, nil)

Returns:

  • (Integer)

Raises:



846
847
848
849
850
851
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 846

def join(group)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_join(self_p, group)
  result
end

#last_endpoint ⇒ ::FFI::AutoPointer

Get socket option ‘last_endpoint`. Available from libzmq 3.0.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



3504
3505
3506
3507
3508
3509
3510
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3504

def last_endpoint()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_last_endpoint(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

#leave(group) ⇒ Integer

Leave a group for the RADIO-DISH pattern. Call only on ZMQ_DISH. Returns 0 if OK, -1 if failed.

Parameters:

  • group (String, #to_s, nil)

Returns:

  • (Integer)

Raises:



873
874
875
876
877
878
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 873

def leave(group)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_leave(self_p, group)
  result
end

#linger ⇒ Integer

Get socket option ‘linger`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



4291
4292
4293
4294
4295
4296
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4291

def linger()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_linger(self_p)
  result
end

#maxmsgsize ⇒ Integer

Get socket option ‘maxmsgsize`. Available from libzmq 3.0.0.

Returns:

  • (Integer)

Raises:



3097
3098
3099
3100
3101
3102
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3097

def maxmsgsize()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_maxmsgsize(self_p)
  result
end

#mcast_loop ⇒ Integer

Get socket option ‘mcast_loop`. Available from libzmq 2.0.0 to 3.0.0.

Returns:

  • (Integer)

Raises:



4021
4022
4023
4024
4025
4026
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4021

def mcast_loop()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_mcast_loop(self_p)
  result
end

#mechanism ⇒ Integer

Get socket option ‘mechanism`. Available from libzmq 4.0.0.

Returns:

  • (Integer)

Raises:



2181
2182
2183
2184
2185
2186
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2181

def mechanism()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_mechanism(self_p)
  result
end

#multicast_hops ⇒ Integer

Get socket option ‘multicast_hops`. Available from libzmq 3.0.0.

Returns:

  • (Integer)

Raises:



3151
3152
3153
3154
3155
3156
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3151

def multicast_hops()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_multicast_hops(self_p)
  result
end

#multicast_maxtpdu ⇒ Integer

Get socket option ‘multicast_maxtpdu`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



1438
1439
1440
1441
1442
1443
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1438

def multicast_maxtpdu()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_multicast_maxtpdu(self_p)
  result
end

#null? ⇒ Boolean

Returns:

  • (Boolean) 


43
44
45
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 43

def null?
  !@ptr or @ptr.null?
end

#plain_password ⇒ ::FFI::AutoPointer

Get socket option ‘plain_password`. Available from libzmq 4.0.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



2314
2315
2316
2317
2318
2319
2320
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2314

def plain_password()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_plain_password(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

#plain_server ⇒ Integer

Get socket option ‘plain_server`. Available from libzmq 4.0.0.

Returns:

  • (Integer)

Raises:



2206
2207
2208
2209
2210
2211
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2206

def plain_server()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_plain_server(self_p)
  result
end

#plain_username ⇒ ::FFI::AutoPointer

Get socket option ‘plain_username`. Available from libzmq 4.0.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



2260
2261
2262
2263
2264
2265
2266
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2260

def plain_username()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_plain_username(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

#rate ⇒ Integer

Get socket option ‘rate`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



3859
3860
3861
3862
3863
3864
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3859

def rate()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_rate(self_p)
  result
end

#rcvbuf ⇒ Integer

Get socket option ‘rcvbuf`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



4237
4238
4239
4240
4241
4242
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4237

def rcvbuf()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_rcvbuf(self_p)
  result
end

#rcvhwm ⇒ Integer

Get socket option ‘rcvhwm`. Available from libzmq 3.0.0.

Returns:

  • (Integer)

Raises:



3043
3044
3045
3046
3047
3048
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3043

def rcvhwm()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_rcvhwm(self_p)
  result
end

#rcvmore ⇒ Integer

Get socket option ‘rcvmore`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



4586
4587
4588
4589
4590
4591
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4586

def rcvmore()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_rcvmore(self_p)
  result
end

#rcvtimeo ⇒ Integer

Get socket option ‘rcvtimeo`. Available from libzmq 2.2.0.

Returns:

  • (Integer)

Raises:



4075
4076
4077
4078
4079
4080
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4075

def rcvtimeo()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_rcvtimeo(self_p)
  result
end

#reconnect_ivl ⇒ Integer

Get socket option ‘reconnect_ivl`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



4345
4346
4347
4348
4349
4350
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4345

def reconnect_ivl()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_reconnect_ivl(self_p)
  result
end

#reconnect_ivl_max ⇒ Integer

Get socket option ‘reconnect_ivl_max`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



4399
4400
4401
4402
4403
4404
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4399

def reconnect_ivl_max()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_reconnect_ivl_max(self_p)
  result
end

#recovery_ivl ⇒ Integer

Get socket option ‘recovery_ivl`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



3913
3914
3915
3916
3917
3918
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3913

def recovery_ivl()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_recovery_ivl(self_p)
  result
end

#recovery_ivl_msec ⇒ Integer

Get socket option ‘recovery_ivl_msec`. Available from libzmq 2.0.0 to 3.0.0.

Returns:

  • (Integer)

Raises:



3967
3968
3969
3970
3971
3972
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3967

def recovery_ivl_msec()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_recovery_ivl_msec(self_p)
  result
end

#recv(picture, *args) ⇒ Integer

Receive a ‘picture’ message to the socket (or actor). See zsock_send for the format and meaning of the picture. Returns the picture elements into a series of pointers as provided by the caller:

i = int * (stores signed integer)
4 = uint32_t * (stores 32-bit unsigned integer)
8 = uint64_t * (stores 64-bit unsigned integer)
s = char ** (allocates new string)
b = byte **, size_t * (2 arguments) (allocates memory)
c = zchunk_t ** (creates zchunk)
f = zframe_t ** (creates zframe)
U = zuuid_t * (creates a zuuid with the data)
h = zhashx_t ** (creates zhashx)
p = void ** (stores pointer)
m = zmsg_t ** (creates a zmsg with the remaing frames)
z = null, asserts empty frame (0 arguments)
u = uint * (stores unsigned integer, deprecated)

Note that zsock_recv creates the returned objects, and the caller must destroy them when finished with them. The supplied pointers do not need to be initialized. Returns 0 if successful, or -1 if it failed to recv a message, in which case the pointers are not modified. When message frames are truncated (a short message), sets return values to zero/null. If an argument pointer is NULL, does not store any value (skips it). An ‘n’ picture matches an empty frame; if the message does not match, the method will return -1.

Parameters:

Returns:

  • (Integer)

Raises:



495
496
497
498
499
500
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 495

def recv(picture, *args)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_recv(self_p, picture, *args)
  result
end

#routing_id ⇒ Integer

Return socket routing ID if any. This returns 0 if the socket is not of type ZMQ_SERVER or if no request was already received on it.

Returns:

  • (Integer)

Raises:



703
704
705
706
707
708
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 703

def routing_id()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_routing_id(self_p)
  result
end

#send(picture, *args) ⇒ Integer

Send a ‘picture’ message to the socket (or actor). The picture is a string that defines the type of each frame. This makes it easy to send a complex multiframe message in one call. The picture can contain any of these characters, each corresponding to one or two arguments:

i = int (signed)
1 = uint8_t
2 = uint16_t
4 = uint32_t
8 = uint64_t
s = char *
b = byte *, size_t (2 arguments)
c = zchunk_t *
f = zframe_t *
h = zhashx_t *
U = zuuid_t *
p = void * (sends the pointer value, only meaningful over inproc)
m = zmsg_t * (sends all frames in the zmsg)
z = sends zero-sized frame (0 arguments)
u = uint (deprecated)

Note that s, b, c, and f are encoded the same way and the choice is offered as a convenience to the sender, which may or may not already have data in a zchunk or zframe. Does not change or take ownership of any arguments. Returns 0 if successful, -1 if sending failed for any reason.

Parameters:

Returns:

  • (Integer)

Raises:



387
388
389
390
391
392
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 387

def send(picture, *args)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_send(self_p, picture, *args)
  result
end

#set_affinity(affinity) ⇒ void

This method returns an undefined value.

Set socket option ‘affinity`. Available from libzmq 2.0.0.

Parameters:

  • affinity (Integer, #to_int, #to_i)

Raises:



3777
3778
3779
3780
3781
3782
3783
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3777

def set_affinity(affinity)
  raise DestroyedError unless @ptr
  self_p = @ptr
  affinity = Integer(affinity)
  result = ::CZMQ::FFI.zsock_set_affinity(self_p, affinity)
  result
end

#set_backlog(backlog) ⇒ void

This method returns an undefined value.

Set socket option ‘backlog`. Available from libzmq 2.0.0.

Parameters:

  • backlog (Integer, #to_int, #to_i)

Raises:



4479
4480
4481
4482
4483
4484
4485
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4479

def set_backlog(backlog)
  raise DestroyedError unless @ptr
  self_p = @ptr
  backlog = Integer(backlog)
  result = ::CZMQ::FFI.zsock_set_backlog(self_p, backlog)
  result
end

#set_conflate(conflate) ⇒ void

This method returns an undefined value.

Set socket option ‘conflate`. Available from libzmq 4.0.0.

Parameters:

  • conflate (Integer, #to_int, #to_i)

Raises:



2099
2100
2101
2102
2103
2104
2105
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2099

def set_conflate(conflate)
  raise DestroyedError unless @ptr
  self_p = @ptr
  conflate = Integer(conflate)
  result = ::CZMQ::FFI.zsock_set_conflate(self_p, conflate)
  result
end

#set_connect_rid(connect_rid) ⇒ void

This method returns an undefined value.

Set socket option ‘connect_rid`. Available from libzmq 4.1.0.

Parameters:

  • connect_rid (String, #to_s, nil)

Raises:



1792
1793
1794
1795
1796
1797
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1792

def set_connect_rid(connect_rid)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_connect_rid(self_p, connect_rid)
  result
end

#set_connect_rid_bin(connect_rid) ⇒ void

This method returns an undefined value.

Set socket option ‘connect_rid` from 32-octet binary Available from libzmq 4.1.0.

Parameters:

  • connect_rid (::FFI::Pointer, #to_ptr)

Raises:



1819
1820
1821
1822
1823
1824
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1819

def set_connect_rid_bin(connect_rid)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_connect_rid_bin(self_p, connect_rid)
  result
end

#set_connect_timeout(connect_timeout) ⇒ void

This method returns an undefined value.

Set socket option ‘connect_timeout`. Available from libzmq 4.2.0.

Parameters:

  • connect_timeout (Integer, #to_int, #to_i)

Raises:



1331
1332
1333
1334
1335
1336
1337
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1331

def set_connect_timeout(connect_timeout)
  raise DestroyedError unless @ptr
  self_p = @ptr
  connect_timeout = Integer(connect_timeout)
  result = ::CZMQ::FFI.zsock_set_connect_timeout(self_p, connect_timeout)
  result
end

#set_curve_publickey(curve_publickey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_publickey`. Available from libzmq 4.0.0.

Parameters:

  • curve_publickey (String, #to_s, nil)

Raises:



2450
2451
2452
2453
2454
2455
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2450

def set_curve_publickey(curve_publickey)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_curve_publickey(self_p, curve_publickey)
  result
end

#set_curve_publickey_bin(curve_publickey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_publickey` from 32-octet binary Available from libzmq 4.0.0.

Parameters:

  • curve_publickey (::FFI::Pointer, #to_ptr)

Raises:



2477
2478
2479
2480
2481
2482
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2477

def set_curve_publickey_bin(curve_publickey)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_curve_publickey_bin(self_p, curve_publickey)
  result
end

#set_curve_secretkey(curve_secretkey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_secretkey`. Available from libzmq 4.0.0.

Parameters:

  • curve_secretkey (String, #to_s, nil)

Raises:



2531
2532
2533
2534
2535
2536
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2531

def set_curve_secretkey(curve_secretkey)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_curve_secretkey(self_p, curve_secretkey)
  result
end

#set_curve_secretkey_bin(curve_secretkey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_secretkey` from 32-octet binary Available from libzmq 4.0.0.

Parameters:

  • curve_secretkey (::FFI::Pointer, #to_ptr)

Raises:



2558
2559
2560
2561
2562
2563
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2558

def set_curve_secretkey_bin(curve_secretkey)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_curve_secretkey_bin(self_p, curve_secretkey)
  result
end

#set_curve_server(curve_server) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_server`. Available from libzmq 4.0.0.

Parameters:

  • curve_server (Integer, #to_int, #to_i)

Raises:



2394
2395
2396
2397
2398
2399
2400
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2394

def set_curve_server(curve_server)
  raise DestroyedError unless @ptr
  self_p = @ptr
  curve_server = Integer(curve_server)
  result = ::CZMQ::FFI.zsock_set_curve_server(self_p, curve_server)
  result
end

#set_curve_serverkey(curve_serverkey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_serverkey`. Available from libzmq 4.0.0.

Parameters:

  • curve_serverkey (String, #to_s, nil)

Raises:



2612
2613
2614
2615
2616
2617
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2612

def set_curve_serverkey(curve_serverkey)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_curve_serverkey(self_p, curve_serverkey)
  result
end

#set_curve_serverkey_bin(curve_serverkey) ⇒ void

This method returns an undefined value.

Set socket option ‘curve_serverkey` from 32-octet binary Available from libzmq 4.0.0.

Parameters:

  • curve_serverkey (::FFI::Pointer, #to_ptr)

Raises:



2639
2640
2641
2642
2643
2644
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2639

def set_curve_serverkey_bin(curve_serverkey)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_curve_serverkey_bin(self_p, curve_serverkey)
  result
end

#set_delay_attach_on_connect(delay_attach_on_connect) ⇒ void

This method returns an undefined value.

Set socket option ‘delay_attach_on_connect`. Available from libzmq 3.0.0.

Parameters:

  • delay_attach_on_connect (Integer, #to_int, #to_i)

Raises:



3615
3616
3617
3618
3619
3620
3621
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3615

def set_delay_attach_on_connect(delay_attach_on_connect)
  raise DestroyedError unless @ptr
  self_p = @ptr
  delay_attach_on_connect = Integer(delay_attach_on_connect)
  result = ::CZMQ::FFI.zsock_set_delay_attach_on_connect(self_p, delay_attach_on_connect)
  result
end

#set_gssapi_plaintext(gssapi_plaintext) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_plaintext`. Available from libzmq 4.0.0.

Parameters:

  • gssapi_plaintext (Integer, #to_int, #to_i)

Raises:



2745
2746
2747
2748
2749
2750
2751
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2745

def set_gssapi_plaintext(gssapi_plaintext)
  raise DestroyedError unless @ptr
  self_p = @ptr
  gssapi_plaintext = Integer(gssapi_plaintext)
  result = ::CZMQ::FFI.zsock_set_gssapi_plaintext(self_p, gssapi_plaintext)
  result
end

#set_gssapi_principal(gssapi_principal) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_principal`. Available from libzmq 4.0.0.

Parameters:

  • gssapi_principal (String, #to_s, nil)

Raises:



2801
2802
2803
2804
2805
2806
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2801

def set_gssapi_principal(gssapi_principal)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_gssapi_principal(self_p, gssapi_principal)
  result
end

#set_gssapi_server(gssapi_server) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_server`. Available from libzmq 4.0.0.

Parameters:

  • gssapi_server (Integer, #to_int, #to_i)

Raises:



2691
2692
2693
2694
2695
2696
2697
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2691

def set_gssapi_server(gssapi_server)
  raise DestroyedError unless @ptr
  self_p = @ptr
  gssapi_server = Integer(gssapi_server)
  result = ::CZMQ::FFI.zsock_set_gssapi_server(self_p, gssapi_server)
  result
end

#set_gssapi_service_principal(gssapi_service_principal) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_service_principal`. Available from libzmq 4.0.0.

Parameters:

  • gssapi_service_principal (String, #to_s, nil)

Raises:



2855
2856
2857
2858
2859
2860
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2855

def set_gssapi_service_principal(gssapi_service_principal)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_gssapi_service_principal(self_p, gssapi_service_principal)
  result
end

#set_handshake_ivl(handshake_ivl) ⇒ void

This method returns an undefined value.

Set socket option ‘handshake_ivl`. Available from libzmq 4.1.0.

Parameters:

  • handshake_ivl (Integer, #to_int, #to_i)

Raises:



1871
1872
1873
1874
1875
1876
1877
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1871

def set_handshake_ivl(handshake_ivl)
  raise DestroyedError unless @ptr
  self_p = @ptr
  handshake_ivl = Integer(handshake_ivl)
  result = ::CZMQ::FFI.zsock_set_handshake_ivl(self_p, handshake_ivl)
  result
end

#set_heartbeat_ivl(heartbeat_ivl) ⇒ void

This method returns an undefined value.

Set socket option ‘heartbeat_ivl`. Available from libzmq 4.2.0.

Parameters:

  • heartbeat_ivl (Integer, #to_int, #to_i)

Raises:



947
948
949
950
951
952
953
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 947

def set_heartbeat_ivl(heartbeat_ivl)
  raise DestroyedError unless @ptr
  self_p = @ptr
  heartbeat_ivl = Integer(heartbeat_ivl)
  result = ::CZMQ::FFI.zsock_set_heartbeat_ivl(self_p, heartbeat_ivl)
  result
end

#set_heartbeat_timeout(heartbeat_timeout) ⇒ void

This method returns an undefined value.

Set socket option ‘heartbeat_timeout`. Available from libzmq 4.2.0.

Parameters:

  • heartbeat_timeout (Integer, #to_int, #to_i)

Raises:



1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1055

def set_heartbeat_timeout(heartbeat_timeout)
  raise DestroyedError unless @ptr
  self_p = @ptr
  heartbeat_timeout = Integer(heartbeat_timeout)
  result = ::CZMQ::FFI.zsock_set_heartbeat_timeout(self_p, heartbeat_timeout)
  result
end

#set_heartbeat_ttl(heartbeat_ttl) ⇒ void

This method returns an undefined value.

Set socket option ‘heartbeat_ttl`. Available from libzmq 4.2.0.

Parameters:

  • heartbeat_ttl (Integer, #to_int, #to_i)

Raises:



1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1001

def set_heartbeat_ttl(heartbeat_ttl)
  raise DestroyedError unless @ptr
  self_p = @ptr
  heartbeat_ttl = Integer(heartbeat_ttl)
  result = ::CZMQ::FFI.zsock_set_heartbeat_ttl(self_p, heartbeat_ttl)
  result
end

#set_hwm(hwm) ⇒ void

This method returns an undefined value.

Set socket option ‘hwm`. Available from libzmq 2.0.0 to 3.0.0.

Parameters:

  • hwm (Integer, #to_int, #to_i)

Raises:



3669
3670
3671
3672
3673
3674
3675
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3669

def set_hwm(hwm)
  raise DestroyedError unless @ptr
  self_p = @ptr
  hwm = Integer(hwm)
  result = ::CZMQ::FFI.zsock_set_hwm(self_p, hwm)
  result
end

#set_identity(identity) ⇒ void

This method returns an undefined value.

Set socket option ‘identity`. Available from libzmq 2.0.0.

Parameters:

  • identity (String, #to_s, nil)

Raises:



3833
3834
3835
3836
3837
3838
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3833

def set_identity(identity)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_identity(self_p, identity)
  result
end

#set_immediate(immediate) ⇒ void

This method returns an undefined value.

Set socket option ‘immediate`. Available from libzmq 4.0.0.

Parameters:

  • immediate (Integer, #to_int, #to_i)

Raises:



2961
2962
2963
2964
2965
2966
2967
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2961

def set_immediate(immediate)
  raise DestroyedError unless @ptr
  self_p = @ptr
  immediate = Integer(immediate)
  result = ::CZMQ::FFI.zsock_set_immediate(self_p, immediate)
  result
end

#set_invert_matching(invert_matching) ⇒ void

This method returns an undefined value.

Set socket option ‘invert_matching`. Available from libzmq 4.2.0.

Parameters:

  • invert_matching (Integer, #to_int, #to_i)

Raises:



1248
1249
1250
1251
1252
1253
1254
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1248

def set_invert_matching(invert_matching)
  raise DestroyedError unless @ptr
  self_p = @ptr
  invert_matching = Integer(invert_matching)
  result = ::CZMQ::FFI.zsock_set_invert_matching(self_p, invert_matching)
  result
end

#set_ipv4only(ipv4only) ⇒ void

This method returns an undefined value.

Set socket option ‘ipv4only`. Available from libzmq 3.0.0.

Parameters:

  • ipv4only (Integer, #to_int, #to_i)

Raises:



3586
3587
3588
3589
3590
3591
3592
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3586

def set_ipv4only(ipv4only)
  raise DestroyedError unless @ptr
  self_p = @ptr
  ipv4only = Integer(ipv4only)
  result = ::CZMQ::FFI.zsock_set_ipv4only(self_p, ipv4only)
  result
end

#set_ipv6(ipv6) ⇒ void

This method returns an undefined value.

Set socket option ‘ipv6`. Available from libzmq 4.0.0.

Parameters:

  • ipv6 (Integer, #to_int, #to_i)

Raises:



2907
2908
2909
2910
2911
2912
2913
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2907

def set_ipv6(ipv6)
  raise DestroyedError unless @ptr
  self_p = @ptr
  ipv6 = Integer(ipv6)
  result = ::CZMQ::FFI.zsock_set_ipv6(self_p, ipv6)
  result
end

#set_linger(linger) ⇒ void

This method returns an undefined value.

Set socket option ‘linger`. Available from libzmq 2.0.0.

Parameters:

  • linger (Integer, #to_int, #to_i)

Raises:



4317
4318
4319
4320
4321
4322
4323
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4317

def set_linger(linger)
  raise DestroyedError unless @ptr
  self_p = @ptr
  linger = Integer(linger)
  result = ::CZMQ::FFI.zsock_set_linger(self_p, linger)
  result
end

#set_maxmsgsize(maxmsgsize) ⇒ void

This method returns an undefined value.

Set socket option ‘maxmsgsize`. Available from libzmq 3.0.0.

Parameters:

  • maxmsgsize (Integer, #to_int, #to_i)

Raises:



3123
3124
3125
3126
3127
3128
3129
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3123

def set_maxmsgsize(maxmsgsize)
  raise DestroyedError unless @ptr
  self_p = @ptr
  maxmsgsize = Integer(maxmsgsize)
  result = ::CZMQ::FFI.zsock_set_maxmsgsize(self_p, maxmsgsize)
  result
end

#set_mcast_loop(mcast_loop) ⇒ void

This method returns an undefined value.

Set socket option ‘mcast_loop`. Available from libzmq 2.0.0 to 3.0.0.

Parameters:

  • mcast_loop (Integer, #to_int, #to_i)

Raises:



4047
4048
4049
4050
4051
4052
4053
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4047

def set_mcast_loop(mcast_loop)
  raise DestroyedError unless @ptr
  self_p = @ptr
  mcast_loop = Integer(mcast_loop)
  result = ::CZMQ::FFI.zsock_set_mcast_loop(self_p, mcast_loop)
  result
end

#set_multicast_hops(multicast_hops) ⇒ void

This method returns an undefined value.

Set socket option ‘multicast_hops`. Available from libzmq 3.0.0.

Parameters:

  • multicast_hops (Integer, #to_int, #to_i)

Raises:



3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3177

def set_multicast_hops(multicast_hops)
  raise DestroyedError unless @ptr
  self_p = @ptr
  multicast_hops = Integer(multicast_hops)
  result = ::CZMQ::FFI.zsock_set_multicast_hops(self_p, multicast_hops)
  result
end

#set_multicast_maxtpdu(multicast_maxtpdu) ⇒ void

This method returns an undefined value.

Set socket option ‘multicast_maxtpdu`. Available from libzmq 4.2.0.

Parameters:

  • multicast_maxtpdu (Integer, #to_int, #to_i)

Raises:



1464
1465
1466
1467
1468
1469
1470
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1464

def set_multicast_maxtpdu(multicast_maxtpdu)
  raise DestroyedError unless @ptr
  self_p = @ptr
  multicast_maxtpdu = Integer(multicast_maxtpdu)
  result = ::CZMQ::FFI.zsock_set_multicast_maxtpdu(self_p, multicast_maxtpdu)
  result
end

#set_plain_password(plain_password) ⇒ void

This method returns an undefined value.

Set socket option ‘plain_password`. Available from libzmq 4.0.0.

Parameters:

  • plain_password (String, #to_s, nil)

Raises:



2342
2343
2344
2345
2346
2347
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2342

def set_plain_password(plain_password)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_plain_password(self_p, plain_password)
  result
end

#set_plain_server(plain_server) ⇒ void

This method returns an undefined value.

Set socket option ‘plain_server`. Available from libzmq 4.0.0.

Parameters:

  • plain_server (Integer, #to_int, #to_i)

Raises:



2232
2233
2234
2235
2236
2237
2238
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2232

def set_plain_server(plain_server)
  raise DestroyedError unless @ptr
  self_p = @ptr
  plain_server = Integer(plain_server)
  result = ::CZMQ::FFI.zsock_set_plain_server(self_p, plain_server)
  result
end

#set_plain_username(plain_username) ⇒ void

This method returns an undefined value.

Set socket option ‘plain_username`. Available from libzmq 4.0.0.

Parameters:

  • plain_username (String, #to_s, nil)

Raises:



2288
2289
2290
2291
2292
2293
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2288

def set_plain_username(plain_username)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_plain_username(self_p, plain_username)
  result
end

#set_probe_router(probe_router) ⇒ void

This method returns an undefined value.

Set socket option ‘probe_router`. Available from libzmq 4.0.0.

Parameters:

  • probe_router (Integer, #to_int, #to_i)

Raises:



2012
2013
2014
2015
2016
2017
2018
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2012

def set_probe_router(probe_router)
  raise DestroyedError unless @ptr
  self_p = @ptr
  probe_router = Integer(probe_router)
  result = ::CZMQ::FFI.zsock_set_probe_router(self_p, probe_router)
  result
end

#set_rate(rate) ⇒ void

This method returns an undefined value.

Set socket option ‘rate`. Available from libzmq 2.0.0.

Parameters:

  • rate (Integer, #to_int, #to_i)

Raises:



3885
3886
3887
3888
3889
3890
3891
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3885

def set_rate(rate)
  raise DestroyedError unless @ptr
  self_p = @ptr
  rate = Integer(rate)
  result = ::CZMQ::FFI.zsock_set_rate(self_p, rate)
  result
end

#set_rcvbuf(rcvbuf) ⇒ void

This method returns an undefined value.

Set socket option ‘rcvbuf`. Available from libzmq 2.0.0.

Parameters:

  • rcvbuf (Integer, #to_int, #to_i)

Raises:



4263
4264
4265
4266
4267
4268
4269
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4263

def set_rcvbuf(rcvbuf)
  raise DestroyedError unless @ptr
  self_p = @ptr
  rcvbuf = Integer(rcvbuf)
  result = ::CZMQ::FFI.zsock_set_rcvbuf(self_p, rcvbuf)
  result
end

#set_rcvhwm(rcvhwm) ⇒ void

This method returns an undefined value.

Set socket option ‘rcvhwm`. Available from libzmq 3.0.0.

Parameters:

  • rcvhwm (Integer, #to_int, #to_i)

Raises:



3069
3070
3071
3072
3073
3074
3075
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3069

def set_rcvhwm(rcvhwm)
  raise DestroyedError unless @ptr
  self_p = @ptr
  rcvhwm = Integer(rcvhwm)
  result = ::CZMQ::FFI.zsock_set_rcvhwm(self_p, rcvhwm)
  result
end

#set_rcvtimeo(rcvtimeo) ⇒ void

This method returns an undefined value.

Set socket option ‘rcvtimeo`. Available from libzmq 2.2.0.

Parameters:

  • rcvtimeo (Integer, #to_int, #to_i)

Raises:



4101
4102
4103
4104
4105
4106
4107
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4101

def set_rcvtimeo(rcvtimeo)
  raise DestroyedError unless @ptr
  self_p = @ptr
  rcvtimeo = Integer(rcvtimeo)
  result = ::CZMQ::FFI.zsock_set_rcvtimeo(self_p, rcvtimeo)
  result
end

#set_reconnect_ivl(reconnect_ivl) ⇒ void

This method returns an undefined value.

Set socket option ‘reconnect_ivl`. Available from libzmq 2.0.0.

Parameters:

  • reconnect_ivl (Integer, #to_int, #to_i)

Raises:



4371
4372
4373
4374
4375
4376
4377
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4371

def set_reconnect_ivl(reconnect_ivl)
  raise DestroyedError unless @ptr
  self_p = @ptr
  reconnect_ivl = Integer(reconnect_ivl)
  result = ::CZMQ::FFI.zsock_set_reconnect_ivl(self_p, reconnect_ivl)
  result
end

#set_reconnect_ivl_max(reconnect_ivl_max) ⇒ void

This method returns an undefined value.

Set socket option ‘reconnect_ivl_max`. Available from libzmq 2.0.0.

Parameters:

  • reconnect_ivl_max (Integer, #to_int, #to_i)

Raises:



4425
4426
4427
4428
4429
4430
4431
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4425

def set_reconnect_ivl_max(reconnect_ivl_max)
  raise DestroyedError unless @ptr
  self_p = @ptr
  reconnect_ivl_max = Integer(reconnect_ivl_max)
  result = ::CZMQ::FFI.zsock_set_reconnect_ivl_max(self_p, reconnect_ivl_max)
  result
end

#set_recovery_ivl(recovery_ivl) ⇒ void

This method returns an undefined value.

Set socket option ‘recovery_ivl`. Available from libzmq 2.0.0.

Parameters:

  • recovery_ivl (Integer, #to_int, #to_i)

Raises:



3939
3940
3941
3942
3943
3944
3945
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3939

def set_recovery_ivl(recovery_ivl)
  raise DestroyedError unless @ptr
  self_p = @ptr
  recovery_ivl = Integer(recovery_ivl)
  result = ::CZMQ::FFI.zsock_set_recovery_ivl(self_p, recovery_ivl)
  result
end

#set_recovery_ivl_msec(recovery_ivl_msec) ⇒ void

This method returns an undefined value.

Set socket option ‘recovery_ivl_msec`. Available from libzmq 2.0.0 to 3.0.0.

Parameters:

  • recovery_ivl_msec (Integer, #to_int, #to_i)

Raises:



3993
3994
3995
3996
3997
3998
3999
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3993

def set_recovery_ivl_msec(recovery_ivl_msec)
  raise DestroyedError unless @ptr
  self_p = @ptr
  recovery_ivl_msec = Integer(recovery_ivl_msec)
  result = ::CZMQ::FFI.zsock_set_recovery_ivl_msec(self_p, recovery_ivl_msec)
  result
end

#set_req_correlate(req_correlate) ⇒ void

This method returns an undefined value.

Set socket option ‘req_correlate`. Available from libzmq 4.0.0.

Parameters:

  • req_correlate (Integer, #to_int, #to_i)

Raises:



2070
2071
2072
2073
2074
2075
2076
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2070

def set_req_correlate(req_correlate)
  raise DestroyedError unless @ptr
  self_p = @ptr
  req_correlate = Integer(req_correlate)
  result = ::CZMQ::FFI.zsock_set_req_correlate(self_p, req_correlate)
  result
end

#set_req_relaxed(req_relaxed) ⇒ void

This method returns an undefined value.

Set socket option ‘req_relaxed`. Available from libzmq 4.0.0.

Parameters:

  • req_relaxed (Integer, #to_int, #to_i)

Raises:



2041
2042
2043
2044
2045
2046
2047
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2041

def set_req_relaxed(req_relaxed)
  raise DestroyedError unless @ptr
  self_p = @ptr
  req_relaxed = Integer(req_relaxed)
  result = ::CZMQ::FFI.zsock_set_req_relaxed(self_p, req_relaxed)
  result
end

#set_router_handover(router_handover) ⇒ void

This method returns an undefined value.

Set socket option ‘router_handover`. Available from libzmq 4.1.0.

Parameters:

  • router_handover (Integer, #to_int, #to_i)

Raises:



1763
1764
1765
1766
1767
1768
1769
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1763

def set_router_handover(router_handover)
  raise DestroyedError unless @ptr
  self_p = @ptr
  router_handover = Integer(router_handover)
  result = ::CZMQ::FFI.zsock_set_router_handover(self_p, router_handover)
  result
end

#set_router_mandatory(router_mandatory) ⇒ void

This method returns an undefined value.

Set socket option ‘router_mandatory`. Available from libzmq 4.0.0.

Parameters:

  • router_mandatory (Integer, #to_int, #to_i)

Raises:



1983
1984
1985
1986
1987
1988
1989
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1983

def set_router_mandatory(router_mandatory)
  raise DestroyedError unless @ptr
  self_p = @ptr
  router_mandatory = Integer(router_mandatory)
  result = ::CZMQ::FFI.zsock_set_router_mandatory(self_p, router_mandatory)
  result
end

#set_router_raw(router_raw) ⇒ void

This method returns an undefined value.

Set socket option ‘router_raw`. Available from libzmq 3.0.0.

Parameters:

  • router_raw (Integer, #to_int, #to_i)

Raises:



3532
3533
3534
3535
3536
3537
3538
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3532

def set_router_raw(router_raw)
  raise DestroyedError unless @ptr
  self_p = @ptr
  router_raw = Integer(router_raw)
  result = ::CZMQ::FFI.zsock_set_router_raw(self_p, router_raw)
  result
end

#set_routing_id(routing_id) ⇒ void

This method returns an undefined value.

Set routing ID on socket. The socket MUST be of type ZMQ_SERVER. This will be used when sending messages on the socket via the zsock API.

Parameters:

  • routing_id (Integer, #to_int, #to_i)

Raises:



715
716
717
718
719
720
721
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 715

def set_routing_id(routing_id)
  raise DestroyedError unless @ptr
  self_p = @ptr
  routing_id = Integer(routing_id)
  result = ::CZMQ::FFI.zsock_set_routing_id(self_p, routing_id)
  result
end

#set_sndbuf(sndbuf) ⇒ void

This method returns an undefined value.

Set socket option ‘sndbuf`. Available from libzmq 2.0.0.

Parameters:

  • sndbuf (Integer, #to_int, #to_i)

Raises:



4209
4210
4211
4212
4213
4214
4215
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4209

def set_sndbuf(sndbuf)
  raise DestroyedError unless @ptr
  self_p = @ptr
  sndbuf = Integer(sndbuf)
  result = ::CZMQ::FFI.zsock_set_sndbuf(self_p, sndbuf)
  result
end

#set_sndhwm(sndhwm) ⇒ void

This method returns an undefined value.

Set socket option ‘sndhwm`. Available from libzmq 3.0.0.

Parameters:

  • sndhwm (Integer, #to_int, #to_i)

Raises:



3015
3016
3017
3018
3019
3020
3021
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3015

def set_sndhwm(sndhwm)
  raise DestroyedError unless @ptr
  self_p = @ptr
  sndhwm = Integer(sndhwm)
  result = ::CZMQ::FFI.zsock_set_sndhwm(self_p, sndhwm)
  result
end

#set_sndtimeo(sndtimeo) ⇒ void

This method returns an undefined value.

Set socket option ‘sndtimeo`. Available from libzmq 2.2.0.

Parameters:

  • sndtimeo (Integer, #to_int, #to_i)

Raises:



4155
4156
4157
4158
4159
4160
4161
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4155

def set_sndtimeo(sndtimeo)
  raise DestroyedError unless @ptr
  self_p = @ptr
  sndtimeo = Integer(sndtimeo)
  result = ::CZMQ::FFI.zsock_set_sndtimeo(self_p, sndtimeo)
  result
end

#set_socks_proxy(socks_proxy) ⇒ void

This method returns an undefined value.

Set socket option ‘socks_proxy`. Available from libzmq 4.1.0.

Parameters:

  • socks_proxy (String, #to_s, nil)

Raises:



1927
1928
1929
1930
1931
1932
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1927

def set_socks_proxy(socks_proxy)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_socks_proxy(self_p, socks_proxy)
  result
end

#set_stream_notify(stream_notify) ⇒ void

This method returns an undefined value.

Set socket option ‘stream_notify`. Available from libzmq 4.2.0.

Parameters:

  • stream_notify (Integer, #to_int, #to_i)

Raises:



1194
1195
1196
1197
1198
1199
1200
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1194

def set_stream_notify(stream_notify)
  raise DestroyedError unless @ptr
  self_p = @ptr
  stream_notify = Integer(stream_notify)
  result = ::CZMQ::FFI.zsock_set_stream_notify(self_p, stream_notify)
  result
end

#set_subscribe(subscribe) ⇒ void

This method returns an undefined value.

Set socket option ‘subscribe`. Available from libzmq 2.0.0.

Parameters:

  • subscribe (String, #to_s, nil)

Raises:



4508
4509
4510
4511
4512
4513
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4508

def set_subscribe(subscribe)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_subscribe(self_p, subscribe)
  result
end

#set_swap(swap) ⇒ void

This method returns an undefined value.

Set socket option ‘swap`. Available from libzmq 2.0.0 to 3.0.0.

Parameters:

  • swap (Integer, #to_int, #to_i)

Raises:



3723
3724
3725
3726
3727
3728
3729
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3723

def set_swap(swap)
  raise DestroyedError unless @ptr
  self_p = @ptr
  swap = Integer(swap)
  result = ::CZMQ::FFI.zsock_set_swap(self_p, swap)
  result
end

#set_tcp_accept_filter(tcp_accept_filter) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_accept_filter`. Available from libzmq 3.0.0.

Parameters:

  • tcp_accept_filter (String, #to_s, nil)

Raises:



3478
3479
3480
3481
3482
3483
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3478

def set_tcp_accept_filter(tcp_accept_filter)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_tcp_accept_filter(self_p, tcp_accept_filter)
  result
end

#set_tcp_keepalive(tcp_keepalive) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_keepalive`. Available from libzmq 3.0.0.

Parameters:

  • tcp_keepalive (Integer, #to_int, #to_i)

Raises:



3260
3261
3262
3263
3264
3265
3266
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3260

def set_tcp_keepalive(tcp_keepalive)
  raise DestroyedError unless @ptr
  self_p = @ptr
  tcp_keepalive = Integer(tcp_keepalive)
  result = ::CZMQ::FFI.zsock_set_tcp_keepalive(self_p, tcp_keepalive)
  result
end

#set_tcp_keepalive_cnt(tcp_keepalive_cnt) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_keepalive_cnt`. Available from libzmq 3.0.0.

Parameters:

  • tcp_keepalive_cnt (Integer, #to_int, #to_i)

Raises:



3368
3369
3370
3371
3372
3373
3374
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3368

def set_tcp_keepalive_cnt(tcp_keepalive_cnt)
  raise DestroyedError unless @ptr
  self_p = @ptr
  tcp_keepalive_cnt = Integer(tcp_keepalive_cnt)
  result = ::CZMQ::FFI.zsock_set_tcp_keepalive_cnt(self_p, tcp_keepalive_cnt)
  result
end

#set_tcp_keepalive_idle(tcp_keepalive_idle) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_keepalive_idle`. Available from libzmq 3.0.0.

Parameters:

  • tcp_keepalive_idle (Integer, #to_int, #to_i)

Raises:



3314
3315
3316
3317
3318
3319
3320
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3314

def set_tcp_keepalive_idle(tcp_keepalive_idle)
  raise DestroyedError unless @ptr
  self_p = @ptr
  tcp_keepalive_idle = Integer(tcp_keepalive_idle)
  result = ::CZMQ::FFI.zsock_set_tcp_keepalive_idle(self_p, tcp_keepalive_idle)
  result
end

#set_tcp_keepalive_intvl(tcp_keepalive_intvl) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_keepalive_intvl`. Available from libzmq 3.0.0.

Parameters:

  • tcp_keepalive_intvl (Integer, #to_int, #to_i)

Raises:



3422
3423
3424
3425
3426
3427
3428
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3422

def set_tcp_keepalive_intvl(tcp_keepalive_intvl)
  raise DestroyedError unless @ptr
  self_p = @ptr
  tcp_keepalive_intvl = Integer(tcp_keepalive_intvl)
  result = ::CZMQ::FFI.zsock_set_tcp_keepalive_intvl(self_p, tcp_keepalive_intvl)
  result
end

#set_tcp_maxrt(tcp_maxrt) ⇒ void

This method returns an undefined value.

Set socket option ‘tcp_maxrt`. Available from libzmq 4.2.0.

Parameters:

  • tcp_maxrt (Integer, #to_int, #to_i)

Raises:



1385
1386
1387
1388
1389
1390
1391
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1385

def set_tcp_maxrt(tcp_maxrt)
  raise DestroyedError unless @ptr
  self_p = @ptr
  tcp_maxrt = Integer(tcp_maxrt)
  result = ::CZMQ::FFI.zsock_set_tcp_maxrt(self_p, tcp_maxrt)
  result
end

#set_tos(tos) ⇒ void

This method returns an undefined value.

Set socket option ‘tos`. Available from libzmq 4.1.0.

Parameters:

  • tos (Integer, #to_int, #to_i)

Raises:



1734
1735
1736
1737
1738
1739
1740
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1734

def set_tos(tos)
  raise DestroyedError unless @ptr
  self_p = @ptr
  tos = Integer(tos)
  result = ::CZMQ::FFI.zsock_set_tos(self_p, tos)
  result
end

#set_unbounded ⇒ void

This method returns an undefined value.

Set socket to use unbounded pipes (HWM=0); use this in cases when you are totally certain the message volume can fit in memory. This method works across all versions of ZeroMQ. Takes a polymorphic socket reference.

Raises:



728
729
730
731
732
733
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 728

def set_unbounded()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_unbounded(self_p)
  result
end

#set_unsubscribe(unsubscribe) ⇒ void

This method returns an undefined value.

Set socket option ‘unsubscribe`. Available from libzmq 2.0.0.

Parameters:

  • unsubscribe (String, #to_s, nil)

Raises:



4535
4536
4537
4538
4539
4540
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4535

def set_unsubscribe(unsubscribe)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_unsubscribe(self_p, unsubscribe)
  result
end

#set_use_fd(use_fd) ⇒ void

This method returns an undefined value.

Set socket option ‘use_fd`. Available from libzmq 4.2.0.

Parameters:

  • use_fd (Integer, #to_int, #to_i)

Raises:



1109
1110
1111
1112
1113
1114
1115
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1109

def set_use_fd(use_fd)
  raise DestroyedError unless @ptr
  self_p = @ptr
  use_fd = Integer(use_fd)
  result = ::CZMQ::FFI.zsock_set_use_fd(self_p, use_fd)
  result
end

#set_vmci_buffer_max_size(vmci_buffer_max_size) ⇒ void

This method returns an undefined value.

Set socket option ‘vmci_buffer_max_size`. Available from libzmq 4.2.0.

Parameters:

  • vmci_buffer_max_size (Integer, #to_int, #to_i)

Raises:



1626
1627
1628
1629
1630
1631
1632
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1626

def set_vmci_buffer_max_size(vmci_buffer_max_size)
  raise DestroyedError unless @ptr
  self_p = @ptr
  vmci_buffer_max_size = Integer(vmci_buffer_max_size)
  result = ::CZMQ::FFI.zsock_set_vmci_buffer_max_size(self_p, vmci_buffer_max_size)
  result
end

#set_vmci_buffer_min_size(vmci_buffer_min_size) ⇒ void

This method returns an undefined value.

Set socket option ‘vmci_buffer_min_size`. Available from libzmq 4.2.0.

Parameters:

  • vmci_buffer_min_size (Integer, #to_int, #to_i)

Raises:



1572
1573
1574
1575
1576
1577
1578
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1572

def set_vmci_buffer_min_size(vmci_buffer_min_size)
  raise DestroyedError unless @ptr
  self_p = @ptr
  vmci_buffer_min_size = Integer(vmci_buffer_min_size)
  result = ::CZMQ::FFI.zsock_set_vmci_buffer_min_size(self_p, vmci_buffer_min_size)
  result
end

#set_vmci_buffer_size(vmci_buffer_size) ⇒ void

This method returns an undefined value.

Set socket option ‘vmci_buffer_size`. Available from libzmq 4.2.0.

Parameters:

  • vmci_buffer_size (Integer, #to_int, #to_i)

Raises:



1518
1519
1520
1521
1522
1523
1524
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1518

def set_vmci_buffer_size(vmci_buffer_size)
  raise DestroyedError unless @ptr
  self_p = @ptr
  vmci_buffer_size = Integer(vmci_buffer_size)
  result = ::CZMQ::FFI.zsock_set_vmci_buffer_size(self_p, vmci_buffer_size)
  result
end

#set_vmci_connect_timeout(vmci_connect_timeout) ⇒ void

This method returns an undefined value.

Set socket option ‘vmci_connect_timeout`. Available from libzmq 4.2.0.

Parameters:

  • vmci_connect_timeout (Integer, #to_int, #to_i)

Raises:



1680
1681
1682
1683
1684
1685
1686
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1680

def set_vmci_connect_timeout(vmci_connect_timeout)
  raise DestroyedError unless @ptr
  self_p = @ptr
  vmci_connect_timeout = Integer(vmci_connect_timeout)
  result = ::CZMQ::FFI.zsock_set_vmci_connect_timeout(self_p, vmci_connect_timeout)
  result
end

#set_xpub_manual(xpub_manual) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_manual`. Available from libzmq 4.2.0.

Parameters:

  • xpub_manual (Integer, #to_int, #to_i)

Raises:



1138
1139
1140
1141
1142
1143
1144
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1138

def set_xpub_manual(xpub_manual)
  raise DestroyedError unless @ptr
  self_p = @ptr
  xpub_manual = Integer(xpub_manual)
  result = ::CZMQ::FFI.zsock_set_xpub_manual(self_p, xpub_manual)
  result
end

#set_xpub_nodrop(xpub_nodrop) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_nodrop`. Available from libzmq 4.1.0.

Parameters:

  • xpub_nodrop (Integer, #to_int, #to_i)

Raises:



1954
1955
1956
1957
1958
1959
1960
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1954

def set_xpub_nodrop(xpub_nodrop)
  raise DestroyedError unless @ptr
  self_p = @ptr
  xpub_nodrop = Integer(xpub_nodrop)
  result = ::CZMQ::FFI.zsock_set_xpub_nodrop(self_p, xpub_nodrop)
  result
end

#set_xpub_verbose(xpub_verbose) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_verbose`. Available from libzmq 3.0.0.

Parameters:

  • xpub_verbose (Integer, #to_int, #to_i)

Raises:



3206
3207
3208
3209
3210
3211
3212
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3206

def set_xpub_verbose(xpub_verbose)
  raise DestroyedError unless @ptr
  self_p = @ptr
  xpub_verbose = Integer(xpub_verbose)
  result = ::CZMQ::FFI.zsock_set_xpub_verbose(self_p, xpub_verbose)
  result
end

#set_xpub_verboser(xpub_verboser) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_verboser`. Available from libzmq 4.2.0.

Parameters:

  • xpub_verboser (Integer, #to_int, #to_i)

Raises:



1277
1278
1279
1280
1281
1282
1283
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1277

def set_xpub_verboser(xpub_verboser)
  raise DestroyedError unless @ptr
  self_p = @ptr
  xpub_verboser = Integer(xpub_verboser)
  result = ::CZMQ::FFI.zsock_set_xpub_verboser(self_p, xpub_verboser)
  result
end

#set_xpub_welcome_msg(xpub_welcome_msg) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_welcome_msg`. Available from libzmq 4.2.0.

Parameters:

  • xpub_welcome_msg (String, #to_s, nil)

Raises:



1167
1168
1169
1170
1171
1172
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1167

def set_xpub_welcome_msg(xpub_welcome_msg)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_xpub_welcome_msg(self_p, xpub_welcome_msg)
  result
end

#set_zap_domain(zap_domain) ⇒ void

This method returns an undefined value.

Set socket option ‘zap_domain`. Available from libzmq 4.0.0.

Parameters:

  • zap_domain (String, #to_s, nil)

Raises:



2155
2156
2157
2158
2159
2160
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2155

def set_zap_domain(zap_domain)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_zap_domain(self_p, zap_domain)
  result
end

#signal(status) ⇒ Integer

Send a signal over a socket. A signal is a short message carrying a success/failure code (by convention, 0 means OK). Signals are encoded to be distinguishable from “normal” messages. Accepts a zsock_t or a zactor_t argument, and returns 0 if successful, -1 if the signal could not be sent. Takes a polymorphic socket reference.

Parameters:

  • status (Integer, #to_int, #to_i)

Returns:

  • (Integer)

Raises:



758
759
760
761
762
763
764
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 758

def signal(status)
  raise DestroyedError unless @ptr
  self_p = @ptr
  status = Integer(status)
  result = ::CZMQ::FFI.zsock_signal(self_p, status)
  result
end

#sndbuf ⇒ Integer

Get socket option ‘sndbuf`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



4183
4184
4185
4186
4187
4188
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4183

def sndbuf()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_sndbuf(self_p)
  result
end

#sndhwm ⇒ Integer

Get socket option ‘sndhwm`. Available from libzmq 3.0.0.

Returns:

  • (Integer)

Raises:



2989
2990
2991
2992
2993
2994
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2989

def sndhwm()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_sndhwm(self_p)
  result
end

#sndtimeo ⇒ Integer

Get socket option ‘sndtimeo`. Available from libzmq 2.2.0.

Returns:

  • (Integer)

Raises:



4129
4130
4131
4132
4133
4134
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4129

def sndtimeo()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_sndtimeo(self_p)
  result
end

#socks_proxy ⇒ ::FFI::AutoPointer

Get socket option ‘socks_proxy`. Available from libzmq 4.1.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



1899
1900
1901
1902
1903
1904
1905
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1899

def socks_proxy()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_socks_proxy(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

#swap ⇒ Integer

Get socket option ‘swap`. Available from libzmq 2.0.0 to 3.0.0.

Returns:

  • (Integer)

Raises:



3697
3698
3699
3700
3701
3702
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3697

def swap()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_swap(self_p)
  result
end

#tcp_accept_filter ⇒ ::FFI::AutoPointer

Get socket option ‘tcp_accept_filter`. Available from libzmq 3.0.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



3450
3451
3452
3453
3454
3455
3456
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3450

def tcp_accept_filter()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_tcp_accept_filter(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end

#tcp_keepalive ⇒ Integer

Get socket option ‘tcp_keepalive`. Available from libzmq 3.0.0.

Returns:

  • (Integer)

Raises:



3234
3235
3236
3237
3238
3239
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3234

def tcp_keepalive()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_tcp_keepalive(self_p)
  result
end

#tcp_keepalive_cnt ⇒ Integer

Get socket option ‘tcp_keepalive_cnt`. Available from libzmq 3.0.0.

Returns:

  • (Integer)

Raises:



3342
3343
3344
3345
3346
3347
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3342

def tcp_keepalive_cnt()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_tcp_keepalive_cnt(self_p)
  result
end

#tcp_keepalive_idle ⇒ Integer

Get socket option ‘tcp_keepalive_idle`. Available from libzmq 3.0.0.

Returns:

  • (Integer)

Raises:



3288
3289
3290
3291
3292
3293
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3288

def tcp_keepalive_idle()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_tcp_keepalive_idle(self_p)
  result
end

#tcp_keepalive_intvl ⇒ Integer

Get socket option ‘tcp_keepalive_intvl`. Available from libzmq 3.0.0.

Returns:

  • (Integer)

Raises:



3396
3397
3398
3399
3400
3401
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3396

def tcp_keepalive_intvl()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_tcp_keepalive_intvl(self_p)
  result
end

#tcp_maxrt ⇒ Integer

Get socket option ‘tcp_maxrt`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



1359
1360
1361
1362
1363
1364
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1359

def tcp_maxrt()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_tcp_maxrt(self_p)
  result
end

#thread_safe ⇒ Integer

Get socket option ‘thread_safe`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



1413
1414
1415
1416
1417
1418
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1413

def thread_safe()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_thread_safe(self_p)
  result
end

#tos ⇒ Integer

Get socket option ‘tos`. Available from libzmq 4.1.0.

Returns:

  • (Integer)

Raises:



1708
1709
1710
1711
1712
1713
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1708

def tos()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_tos(self_p)
  result
end

#type ⇒ Integer

Get socket option ‘type`. Available from libzmq 2.0.0.

Returns:

  • (Integer)

Raises:



4561
4562
4563
4564
4565
4566
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4561

def type()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_type(self_p)
  result
end

#type_str ⇒ String

Returns socket type as printable constant string.

Returns:

  • (String)

Raises:



350
351
352
353
354
355
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 350

def type_str()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_type_str(self_p)
  result
end

#unbind(format, *args) ⇒ Integer

Unbind a socket from a formatted endpoint. Returns 0 if OK, -1 if the endpoint was invalid or the function isn’t supported.

Parameters:

Returns:

  • (Integer)

Raises:



295
296
297
298
299
300
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 295

def unbind(format, *args)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_unbind(self_p, format, *args)
  result
end

#use_fd ⇒ Integer

Get socket option ‘use_fd`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



1083
1084
1085
1086
1087
1088
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1083

def use_fd()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_use_fd(self_p)
  result
end

#vmci_buffer_max_size ⇒ Integer

Get socket option ‘vmci_buffer_max_size`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



1600
1601
1602
1603
1604
1605
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1600

def vmci_buffer_max_size()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_vmci_buffer_max_size(self_p)
  result
end

#vmci_buffer_min_size ⇒ Integer

Get socket option ‘vmci_buffer_min_size`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



1546
1547
1548
1549
1550
1551
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1546

def vmci_buffer_min_size()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_vmci_buffer_min_size(self_p)
  result
end

#vmci_buffer_size ⇒ Integer

Get socket option ‘vmci_buffer_size`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



1492
1493
1494
1495
1496
1497
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1492

def vmci_buffer_size()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_vmci_buffer_size(self_p)
  result
end

#vmci_connect_timeout ⇒ Integer

Get socket option ‘vmci_connect_timeout`. Available from libzmq 4.2.0.

Returns:

  • (Integer)

Raises:



1654
1655
1656
1657
1658
1659
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1654

def vmci_connect_timeout()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_vmci_connect_timeout(self_p)
  result
end

#vrecv(picture, argptr) ⇒ Integer

Receive a ‘picture’ message from the socket (or actor). This is a va_list version of zsock_recv (), so please consult its documentation for the details.

Parameters:

  • picture (String, #to_s, nil)
  • argptr (::FFI::Pointer, #to_ptr)

Returns:

  • (Integer)

Raises:



549
550
551
552
553
554
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 549

def vrecv(picture, argptr)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_vrecv(self_p, picture, argptr)
  result
end

#vsend(picture, argptr) ⇒ Integer

Send a ‘picture’ message to the socket (or actor). This is a va_list version of zsock_send (), so please consult its documentation for the details.

Parameters:

  • picture (String, #to_s, nil)
  • argptr (::FFI::Pointer, #to_ptr)

Returns:

  • (Integer)

Raises:



441
442
443
444
445
446
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 441

def vsend(picture, argptr)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_vsend(self_p, picture, argptr)
  result
end

#wait ⇒ Integer

Wait on a signal. Use this to coordinate between threads, over pipe pairs. Blocks until the signal is received. Returns -1 on error, 0 or greater on success. Accepts a zsock_t or a zactor_t as argument. Takes a polymorphic socket reference.

Returns:

  • (Integer)

Raises:



791
792
793
794
795
796
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 791

def wait()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_wait(self_p)
  result
end

#zap_domain ⇒ ::FFI::AutoPointer

Get socket option ‘zap_domain`. Available from libzmq 4.0.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



2127
2128
2129
2130
2131
2132
2133
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2127

def zap_domain()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_zap_domain(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end