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

.__newObject



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)


4819
4820
4821
4822
4823
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4819

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)


5521
5522
5523
5524
5525
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5521

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

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

Get socket option ‘bindtodevice`. Available from libzmq 4.3.0.

This is the polymorphic version of #bindtodevice.

Parameters:

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

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer)


1936
1937
1938
1939
1940
1941
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1936

def self.bindtodevice(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_bindtodevice(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  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)


714
715
716
717
718
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 714

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)


655
656
657
658
659
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 655

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)


2373
2374
2375
2376
2377
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2373

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
42
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 35

def self.create_finalizer_for(ptr)
  ptr_ptr = ::FFI::MemoryPointer.new :pointer

  Proc.new do
    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)


3491
3492
3493
3494
3495
3496
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3491

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)


3572
3573
3574
3575
3576
3577
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3572

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)


3436
3437
3438
3439
3440
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3436

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)


3653
3654
3655
3656
3657
3658
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3653

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)


5704
5705
5706
5707
5708
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5704

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)


5679
5680
5681
5682
5683
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5679

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



856
857
858
859
860
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 856

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)


3787
3788
3789
3790
3791
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3787

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)


3842
3843
3844
3845
3846
3847
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3842

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_principal_nametype(self_p) ⇒ Integer

Get socket option ‘gssapi_principal_nametype`. Available from libzmq 4.3.0.

This is the polymorphic version of #gssapi_principal_nametype.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


1827
1828
1829
1830
1831
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1827

def self.gssapi_principal_nametype(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_gssapi_principal_nametype(self_p)
  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)


3733
3734
3735
3736
3737
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3733

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)


3896
3897
3898
3899
3900
3901
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3896

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

.gssapi_service_principal_nametype(self_p) ⇒ Integer

Get socket option ‘gssapi_service_principal_nametype`. Available from libzmq 4.3.0.

This is the polymorphic version of #gssapi_service_principal_nametype.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


1881
1882
1883
1884
1885
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1881

def self.gssapi_service_principal_nametype(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_gssapi_service_principal_nametype(self_p)
  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)


2913
2914
2915
2916
2917
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2913

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

.has_in(self_p) ⇒ Boolean

Check whether the socket has available message to read.

This is the polymorphic version of #has_in.

Parameters:

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

    object reference to use this method on

Returns:

  • (Boolean)


955
956
957
958
959
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 955

def self.has_in(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_has_in(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)


1989
1990
1991
1992
1993
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1989

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)


2097
2098
2099
2100
2101
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2097

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)


2043
2044
2045
2046
2047
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2043

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)


4711
4712
4713
4714
4715
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4711

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)


4874
4875
4876
4877
4878
4879
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4874

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)


4003
4004
4005
4006
4007
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4003

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

.in_batch_size(self_p) ⇒ Integer

Get socket option ‘in_batch_size`. Available from libzmq 4.3.0.

This is the polymorphic version of #in_batch_size.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


1366
1367
1368
1369
1370
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1366

def self.in_batch_size(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_in_batch_size(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)


2290
2291
2292
2293
2294
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2290

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)


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

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)


3949
3950
3951
3952
3953
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3949

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)


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

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)


883
884
885
886
887
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 883

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)


4573
4574
4575
4576
4577
4578
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4573

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)


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

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)


5359
5360
5361
5362
5363
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5359

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

.loopback_fastpath(self_p) ⇒ Integer

Get socket option ‘loopback_fastpath`. Available from libzmq 4.3.0.

This is the polymorphic version of #loopback_fastpath.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


1719
1720
1721
1722
1723
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1719

def self.loopback_fastpath(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_loopback_fastpath(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)


4165
4166
4167
4168
4169
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4165

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)


5089
5090
5091
5092
5093
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5089

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)


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

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

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

Get socket option ‘metadata`. Available from libzmq 4.3.0.

This is the polymorphic version of #metadata.

Parameters:

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

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer)


1666
1667
1668
1669
1670
1671
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1666

def self.(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  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)


4219
4220
4221
4222
4223
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4219

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_loop(self_p) ⇒ Integer

Get socket option ‘multicast_loop`. Available from libzmq 4.3.0.

This is the polymorphic version of #multicast_loop.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


1611
1612
1613
1614
1615
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1611

def self.multicast_loop(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_multicast_loop(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)


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

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)


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

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)


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

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)


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

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

.new_dgram(endpoint) ⇒ CZMQ::Zsock

Create a DGRAM (UDP) socket. Default action is bind. The endpoint is a string consisting of a ‘transport’‘://` followed by an ’address’. As this is a UDP socket the ‘transport’ has to be ‘udp’. The ‘address’ specifies the ip address and port to bind to. For example: udp://127.0.0.1:1234 Note: To send to an endpoint over UDP you have to send a message with the destination endpoint address as a first message!

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


248
249
250
251
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 248

def self.new_dgram(endpoint)
  ptr = ::CZMQ::FFI.zsock_new_dgram(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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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

.out_batch_size(self_p) ⇒ Integer

Get socket option ‘out_batch_size`. Available from libzmq 4.3.0.

This is the polymorphic version of #out_batch_size.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


1312
1313
1314
1315
1316
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1312

def self.out_batch_size(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_out_batch_size(self_p)
  result
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)


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

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)


3274
3275
3276
3277
3278
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3274

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)


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

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

.priority(self_p) ⇒ Integer

Get socket option ‘priority`. Available from libzmq 4.3.0.

This is the polymorphic version of #priority.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


980
981
982
983
984
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 980

def self.priority(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_priority(self_p)
  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)


4927
4928
4929
4930
4931
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4927

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)


5305
5306
5307
5308
5309
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5305

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)


4111
4112
4113
4114
4115
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4111

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)


5654
5655
5656
5657
5658
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5654

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)


5143
5144
5145
5146
5147
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5143

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)


5413
5414
5415
5416
5417
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5413

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)


5467
5468
5469
5470
5471
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5467

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

.reconnect_stop(self_p) ⇒ Integer

Get socket option ‘reconnect_stop`. Available from libzmq 4.3.0.

This is the polymorphic version of #reconnect_stop.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


1034
1035
1036
1037
1038
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1034

def self.reconnect_stop(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_reconnect_stop(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)


4981
4982
4983
4984
4985
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4981

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)


5035
5036
5037
5038
5039
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5035

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)
l = zlistx_t ** (creates zlistx) (DRAFT)
p = void ** (stores pointer)
m = zmsg_t ** (creates a zmsg with the remaining 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)


557
558
559
560
561
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 557

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)


933
934
935
936
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 933

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

.router_notify(self_p) ⇒ Integer

Get socket option ‘router_notify`. Available from libzmq 4.3.0.

This is the polymorphic version of #router_notify.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


1557
1558
1559
1560
1561
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1557

def self.router_notify(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_router_notify(self_p)
  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 *
l = zlistx_t * (DRAFT)
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)


447
448
449
450
451
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 447

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)


4847
4848
4849
4850
4851
4852
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4847

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)


5549
5550
5551
5552
5553
5554
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5549

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_bindtodevice(self_p, bindtodevice) ⇒ void

This method returns an undefined value.

Set socket option ‘bindtodevice`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_bindtodevice.

Parameters:

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

    object reference to use this method on

  • bindtodevice (String, #to_s, nil)


1964
1965
1966
1967
1968
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1964

def self.set_bindtodevice(self_p, bindtodevice)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_bindtodevice(self_p, bindtodevice)
  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)


3169
3170
3171
3172
3173
3174
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3169

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)


2861
2862
2863
2864
2865
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2861

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)


2888
2889
2890
2891
2892
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2888

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)


2401
2402
2403
2404
2405
2406
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2401

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)


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

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)


3546
3547
3548
3549
3550
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3546

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)


3600
3601
3602
3603
3604
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3600

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)


3627
3628
3629
3630
3631
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3627

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)


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

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)


3681
3682
3683
3684
3685
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3681

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)


3708
3709
3710
3711
3712
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3708

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)


4685
4686
4687
4688
4689
4690
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4685

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_disconnect_msg(self_p, disconnect_msg) ⇒ void

This method returns an undefined value.

Set socket option ‘disconnect_msg`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_disconnect_msg.

Parameters:

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

    object reference to use this method on

  • disconnect_msg (Zframe, #__ptr)


1149
1150
1151
1152
1153
1154
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1149

def self.set_disconnect_msg(self_p, disconnect_msg)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  disconnect_msg = disconnect_msg.__ptr if disconnect_msg
  result = ::CZMQ::FFI.zsock_set_disconnect_msg(self_p, disconnect_msg)
  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)


3815
3816
3817
3818
3819
3820
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3815

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)


3870
3871
3872
3873
3874
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3870

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_principal_nametype(self_p, gssapi_principal_nametype) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_principal_nametype`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_gssapi_principal_nametype.

Parameters:

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

    object reference to use this method on

  • gssapi_principal_nametype (Integer, #to_int, #to_i)


1855
1856
1857
1858
1859
1860
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1855

def self.set_gssapi_principal_nametype(self_p, gssapi_principal_nametype)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  gssapi_principal_nametype = Integer(gssapi_principal_nametype)
  result = ::CZMQ::FFI.zsock_set_gssapi_principal_nametype(self_p, gssapi_principal_nametype)
  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)


3761
3762
3763
3764
3765
3766
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3761

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)


3924
3925
3926
3927
3928
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3924

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_gssapi_service_principal_nametype(self_p, gssapi_service_principal_nametype) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_service_principal_nametype`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_gssapi_service_principal_nametype.

Parameters:

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

    object reference to use this method on

  • gssapi_service_principal_nametype (Integer, #to_int, #to_i)


1909
1910
1911
1912
1913
1914
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1909

def self.set_gssapi_service_principal_nametype(self_p, gssapi_service_principal_nametype)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  gssapi_service_principal_nametype = Integer(gssapi_service_principal_nametype)
  result = ::CZMQ::FFI.zsock_set_gssapi_service_principal_nametype(self_p, gssapi_service_principal_nametype)
  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)


2941
2942
2943
2944
2945
2946
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2941

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)


2017
2018
2019
2020
2021
2022
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2017

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)


2125
2126
2127
2128
2129
2130
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2125

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)


2071
2072
2073
2074
2075
2076
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2071

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_hello_msg(self_p, hello_msg) ⇒ void

This method returns an undefined value.

Set socket option ‘hello_msg`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_hello_msg.

Parameters:

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

    object reference to use this method on

  • hello_msg (Zframe, #__ptr)


1120
1121
1122
1123
1124
1125
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1120

def self.set_hello_msg(self_p, hello_msg)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  hello_msg = hello_msg.__ptr if hello_msg
  result = ::CZMQ::FFI.zsock_set_hello_msg(self_p, hello_msg)
  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)


4739
4740
4741
4742
4743
4744
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4739

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)


4902
4903
4904
4905
4906
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4902

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)


4031
4032
4033
4034
4035
4036
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4031

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_in_batch_size(self_p, in_batch_size) ⇒ void

This method returns an undefined value.

Set socket option ‘in_batch_size`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_in_batch_size.

Parameters:

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

    object reference to use this method on

  • in_batch_size (Integer, #to_int, #to_i)


1394
1395
1396
1397
1398
1399
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1394

def self.set_in_batch_size(self_p, in_batch_size)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  in_batch_size = Integer(in_batch_size)
  result = ::CZMQ::FFI.zsock_set_in_batch_size(self_p, in_batch_size)
  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)


2318
2319
2320
2321
2322
2323
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2318

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)


4656
4657
4658
4659
4660
4661
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4656

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)


3977
3978
3979
3980
3981
3982
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3977

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)


5387
5388
5389
5390
5391
5392
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5387

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_loopback_fastpath(self_p, loopback_fastpath) ⇒ void

This method returns an undefined value.

Set socket option ‘loopback_fastpath`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_loopback_fastpath.

Parameters:

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

    object reference to use this method on

  • loopback_fastpath (Integer, #to_int, #to_i)


1747
1748
1749
1750
1751
1752
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1747

def self.set_loopback_fastpath(self_p, loopback_fastpath)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  loopback_fastpath = Integer(loopback_fastpath)
  result = ::CZMQ::FFI.zsock_set_loopback_fastpath(self_p, loopback_fastpath)
  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)


4193
4194
4195
4196
4197
4198
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4193

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)


5117
5118
5119
5120
5121
5122
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5117

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_metadata(self_p, metadata) ⇒ void

This method returns an undefined value.

Set socket option ‘metadata`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_metadata.

Parameters:

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

    object reference to use this method on

  • metadata (String, #to_s, nil)


1694
1695
1696
1697
1698
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1694

def self.(self_p, )
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.(self_p, )
  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)


4247
4248
4249
4250
4251
4252
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4247

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_loop(self_p, multicast_loop) ⇒ void

This method returns an undefined value.

Set socket option ‘multicast_loop`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_multicast_loop.

Parameters:

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

    object reference to use this method on

  • multicast_loop (Integer, #to_int, #to_i)


1639
1640
1641
1642
1643
1644
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1639

def self.set_multicast_loop(self_p, multicast_loop)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  multicast_loop = Integer(multicast_loop)
  result = ::CZMQ::FFI.zsock_set_multicast_loop(self_p, multicast_loop)
  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)


2534
2535
2536
2537
2538
2539
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2534

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_only_first_subscribe(self_p, only_first_subscribe) ⇒ void

This method returns an undefined value.

Set socket option ‘only_first_subscribe`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_only_first_subscribe.

Parameters:

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

    object reference to use this method on

  • only_first_subscribe (Integer, #to_int, #to_i)


1091
1092
1093
1094
1095
1096
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1091

def self.set_only_first_subscribe(self_p, only_first_subscribe)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  only_first_subscribe = Integer(only_first_subscribe)
  result = ::CZMQ::FFI.zsock_set_only_first_subscribe(self_p, only_first_subscribe)
  result
end

.set_out_batch_size(self_p, out_batch_size) ⇒ void

This method returns an undefined value.

Set socket option ‘out_batch_size`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_out_batch_size.

Parameters:

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

    object reference to use this method on

  • out_batch_size (Integer, #to_int, #to_i)


1340
1341
1342
1343
1344
1345
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1340

def self.set_out_batch_size(self_p, out_batch_size)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  out_batch_size = Integer(out_batch_size)
  result = ::CZMQ::FFI.zsock_set_out_batch_size(self_p, out_batch_size)
  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)


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

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)


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

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)


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

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_priority(self_p, priority) ⇒ void

This method returns an undefined value.

Set socket option ‘priority`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_priority.

Parameters:

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

    object reference to use this method on

  • priority (Integer, #to_int, #to_i)


1008
1009
1010
1011
1012
1013
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1008

def self.set_priority(self_p, priority)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  priority = Integer(priority)
  result = ::CZMQ::FFI.zsock_set_priority(self_p, priority)
  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)


3082
3083
3084
3085
3086
3087
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3082

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)


4955
4956
4957
4958
4959
4960
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4955

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)


5333
5334
5335
5336
5337
5338
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5333

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)


4139
4140
4141
4142
4143
4144
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4139

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)


5171
5172
5173
5174
5175
5176
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5171

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)


5441
5442
5443
5444
5445
5446
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5441

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)


5495
5496
5497
5498
5499
5500
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5495

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_reconnect_stop(self_p, reconnect_stop) ⇒ void

This method returns an undefined value.

Set socket option ‘reconnect_stop`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_reconnect_stop.

Parameters:

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

    object reference to use this method on

  • reconnect_stop (Integer, #to_int, #to_i)


1062
1063
1064
1065
1066
1067
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1062

def self.set_reconnect_stop(self_p, reconnect_stop)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  reconnect_stop = Integer(reconnect_stop)
  result = ::CZMQ::FFI.zsock_set_reconnect_stop(self_p, reconnect_stop)
  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)


5009
5010
5011
5012
5013
5014
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5009

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)


5063
5064
5065
5066
5067
5068
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5063

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)


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

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)


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

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)


2833
2834
2835
2836
2837
2838
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2833

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)


3053
3054
3055
3056
3057
3058
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3053

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_notify(self_p, router_notify) ⇒ void

This method returns an undefined value.

Set socket option ‘router_notify`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_router_notify.

Parameters:

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

    object reference to use this method on

  • router_notify (Integer, #to_int, #to_i)


1585
1586
1587
1588
1589
1590
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1585

def self.set_router_notify(self_p, router_notify)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  router_notify = Integer(router_notify)
  result = ::CZMQ::FFI.zsock_set_router_notify(self_p, router_notify)
  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)


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

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)


5279
5280
5281
5282
5283
5284
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5279

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)


4085
4086
4087
4088
4089
4090
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4085

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)


5225
5226
5227
5228
5229
5230
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5225

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_password(self_p, socks_password) ⇒ void

This method returns an undefined value.

Set socket option ‘socks_password`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_socks_password.

Parameters:

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

    object reference to use this method on

  • socks_password (String, #to_s, nil)


1449
1450
1451
1452
1453
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1449

def self.set_socks_password(self_p, socks_password)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_socks_password(self_p, socks_password)
  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)


2996
2997
2998
2999
3000
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2996

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_socks_username(self_p, socks_username) ⇒ void

This method returns an undefined value.

Set socket option ‘socks_username`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_socks_username.

Parameters:

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

    object reference to use this method on

  • socks_username (String, #to_s, nil)


1503
1504
1505
1506
1507
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1503

def self.set_socks_username(self_p, socks_username)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_socks_username(self_p, socks_username)
  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)


2264
2265
2266
2267
2268
2269
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2264

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)


5577
5578
5579
5580
5581
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5577

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)


4793
4794
4795
4796
4797
4798
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4793

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)


4547
4548
4549
4550
4551
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4547

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)


4330
4331
4332
4333
4334
4335
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4330

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)


4438
4439
4440
4441
4442
4443
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4438

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)


4384
4385
4386
4387
4388
4389
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4384

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)


4492
4493
4494
4495
4496
4497
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4492

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)


2455
2456
2457
2458
2459
2460
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2455

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)


2804
2805
2806
2807
2808
2809
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2804

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



765
766
767
768
769
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 765

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)


5604
5605
5606
5607
5608
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5604

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)


2179
2180
2181
2182
2183
2184
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2179

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)


2696
2697
2698
2699
2700
2701
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2696

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)


2642
2643
2644
2645
2646
2647
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2642

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)


2588
2589
2590
2591
2592
2593
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2588

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)


2750
2751
2752
2753
2754
2755
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2750

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_wss_cert_pem(self_p, wss_cert_pem) ⇒ void

This method returns an undefined value.

Set socket option ‘wss_cert_pem`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_wss_cert_pem.

Parameters:

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

    object reference to use this method on

  • wss_cert_pem (String, #to_s, nil)


1260
1261
1262
1263
1264
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1260

def self.set_wss_cert_pem(self_p, wss_cert_pem)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_wss_cert_pem(self_p, wss_cert_pem)
  result
end

.set_wss_hostname(self_p, wss_hostname) ⇒ void

This method returns an undefined value.

Set socket option ‘wss_hostname`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_wss_hostname.

Parameters:

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

    object reference to use this method on

  • wss_hostname (String, #to_s, nil)


1206
1207
1208
1209
1210
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1206

def self.set_wss_hostname(self_p, wss_hostname)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_wss_hostname(self_p, wss_hostname)
  result
end

.set_wss_key_pem(self_p, wss_key_pem) ⇒ void

This method returns an undefined value.

Set socket option ‘wss_key_pem`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_wss_key_pem.

Parameters:

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

    object reference to use this method on

  • wss_key_pem (String, #to_s, nil)


1287
1288
1289
1290
1291
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1287

def self.set_wss_key_pem(self_p, wss_key_pem)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_wss_key_pem(self_p, wss_key_pem)
  result
end

.set_wss_trust_pem(self_p, wss_trust_pem) ⇒ void

This method returns an undefined value.

Set socket option ‘wss_trust_pem`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_wss_trust_pem.

Parameters:

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

    object reference to use this method on

  • wss_trust_pem (String, #to_s, nil)


1233
1234
1235
1236
1237
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1233

def self.set_wss_trust_pem(self_p, wss_trust_pem)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_set_wss_trust_pem(self_p, wss_trust_pem)
  result
end

.set_wss_trust_system(self_p, wss_trust_system) ⇒ void

This method returns an undefined value.

Set socket option ‘wss_trust_system`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_wss_trust_system.

Parameters:

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

    object reference to use this method on

  • wss_trust_system (Integer, #to_int, #to_i)


1178
1179
1180
1181
1182
1183
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1178

def self.set_wss_trust_system(self_p, wss_trust_system)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  wss_trust_system = Integer(wss_trust_system)
  result = ::CZMQ::FFI.zsock_set_wss_trust_system(self_p, wss_trust_system)
  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)


2208
2209
2210
2211
2212
2213
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2208

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_manual_last_value(self_p, xpub_manual_last_value) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_manual_last_value`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_xpub_manual_last_value.

Parameters:

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

    object reference to use this method on

  • xpub_manual_last_value (Integer, #to_int, #to_i)


1531
1532
1533
1534
1535
1536
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1531

def self.set_xpub_manual_last_value(self_p, xpub_manual_last_value)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  xpub_manual_last_value = Integer(xpub_manual_last_value)
  result = ::CZMQ::FFI.zsock_set_xpub_manual_last_value(self_p, xpub_manual_last_value)
  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)


3024
3025
3026
3027
3028
3029
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3024

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)


4276
4277
4278
4279
4280
4281
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4276

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)


2347
2348
2349
2350
2351
2352
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2347

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)


2236
2237
2238
2239
2240
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2236

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)


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

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

.set_zap_enforce_domain(self_p, zap_enforce_domain) ⇒ void

This method returns an undefined value.

Set socket option ‘zap_enforce_domain`. Available from libzmq 4.3.0.

This is the polymorphic version of #set_zap_enforce_domain.

Parameters:

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

    object reference to use this method on

  • zap_enforce_domain (Integer, #to_int, #to_i)


1801
1802
1803
1804
1805
1806
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1801

def self.set_zap_enforce_domain(self_p, zap_enforce_domain)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  zap_enforce_domain = Integer(zap_enforce_domain)
  result = ::CZMQ::FFI.zsock_set_zap_enforce_domain(self_p, zap_enforce_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)


799
800
801
802
803
804
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 799

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)


5251
5252
5253
5254
5255
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5251

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)


4057
4058
4059
4060
4061
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4057

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)


5197
5198
5199
5200
5201
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5197

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_password(self_p) ⇒ ::FFI::AutoPointer

Get socket option ‘socks_password`. Available from libzmq 4.3.0.

This is the polymorphic version of #socks_password.

Parameters:

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

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer)


1421
1422
1423
1424
1425
1426
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1421

def self.socks_password(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_socks_password(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  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)


2968
2969
2970
2971
2972
2973
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2968

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

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

Get socket option ‘socks_username`. Available from libzmq 4.3.0.

This is the polymorphic version of #socks_username.

Parameters:

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

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer)


1475
1476
1477
1478
1479
1480
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1475

def self.socks_username(self_p)
  self_p = self_p.__ptr if self_p.respond_to?(:__ptr)
  result = ::CZMQ::FFI.zsock_socks_username(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)


4765
4766
4767
4768
4769
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4765

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)


4519
4520
4521
4522
4523
4524
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4519

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)


4302
4303
4304
4305
4306
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4302

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)


4410
4411
4412
4413
4414
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4410

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)


4356
4357
4358
4359
4360
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4356

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)


4464
4465
4466
4467
4468
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4464

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)


2427
2428
2429
2430
2431
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2427

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)


5714
5715
5716
5717
5718
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5714

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)


2481
2482
2483
2484
2485
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2481

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)


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

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)


5629
5630
5631
5632
5633
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5629

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)


2151
2152
2153
2154
2155
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2151

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)


2668
2669
2670
2671
2672
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2668

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)


2614
2615
2616
2617
2618
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2614

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)


2560
2561
2562
2563
2564
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2560

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)


2722
2723
2724
2725
2726
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2722

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)


588
589
590
591
592
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 588

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)


478
479
480
481
482
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 478

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)


829
830
831
832
833
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 829

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)


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

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

.zap_enforce_domain(self_p) ⇒ Integer

Get socket option ‘zap_enforce_domain`. Available from libzmq 4.3.0.

This is the polymorphic version of #zap_enforce_domain.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


1773
1774
1775
1776
1777
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1773

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

Instance Method Details

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

Return internal pointer

Returns:

  • (::FFI::Pointer)

Raises:



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

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:



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

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_finalizervoid

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.



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

def __undef_finalizer
  ObjectSpace.undefine_finalizer self
  @finalizer = nil
end

#affinityInteger

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

Returns:

  • (Integer)

Raises:



4804
4805
4806
4807
4808
4809
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4804

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:



356
357
358
359
360
361
362
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 356

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

#backlogInteger

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

Returns:

  • (Integer)

Raises:



5506
5507
5508
5509
5510
5511
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5506

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:



288
289
290
291
292
293
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 288

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

#bindtodevice::FFI::AutoPointer

Get socket option ‘bindtodevice`. Available from libzmq 4.3.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



1920
1921
1922
1923
1924
1925
1926
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1920

def bindtodevice()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_bindtodevice(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  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:



682
683
684
685
686
687
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 682

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:



619
620
621
622
623
624
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 619

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:



325
326
327
328
329
330
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 325

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

#connect_timeoutInteger

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

Returns:

  • (Integer)

Raises:



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

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:



3475
3476
3477
3478
3479
3480
3481
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3475

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:



3556
3557
3558
3559
3560
3561
3562
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3556

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_serverInteger

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

Returns:

  • (Integer)

Raises:



3421
3422
3423
3424
3425
3426
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3421

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:



3637
3638
3639
3640
3641
3642
3643
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3637

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

#destroyvoid

This method returns an undefined value.

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



257
258
259
260
261
262
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 257

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:



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

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

#endpointString

Returns last bound endpoint, if any.

Returns:

  • (String)

Raises:



298
299
300
301
302
303
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 298

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

#eventsInteger

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

Returns:

  • (Integer)

Raises:



5689
5690
5691
5692
5693
5694
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5689

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

#fdInteger or FFI::Pointer

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

Returns:

  • (Integer or FFI::Pointer)

Raises:



5664
5665
5666
5667
5668
5669
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5664

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

#flushvoid

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:



840
841
842
843
844
845
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 840

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

#gssapi_plaintextInteger

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

Returns:

  • (Integer)

Raises:



3772
3773
3774
3775
3776
3777
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3772

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:



3826
3827
3828
3829
3830
3831
3832
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3826

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_principal_nametypeInteger

Get socket option ‘gssapi_principal_nametype`. Available from libzmq 4.3.0.

Returns:

  • (Integer)

Raises:



1812
1813
1814
1815
1816
1817
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1812

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

#gssapi_serverInteger

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

Returns:

  • (Integer)

Raises:



3718
3719
3720
3721
3722
3723
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3718

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:



3880
3881
3882
3883
3884
3885
3886
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3880

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

#gssapi_service_principal_nametypeInteger

Get socket option ‘gssapi_service_principal_nametype`. Available from libzmq 4.3.0.

Returns:

  • (Integer)

Raises:



1866
1867
1868
1869
1870
1871
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1866

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

#handshake_ivlInteger

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

Returns:

  • (Integer)

Raises:



2898
2899
2900
2901
2902
2903
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2898

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

#has_inBoolean

Check whether the socket has available message to read.

Returns:

  • (Boolean)

Raises:



941
942
943
944
945
946
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 941

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

#heartbeat_ivlInteger

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

Returns:

  • (Integer)

Raises:



1974
1975
1976
1977
1978
1979
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1974

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

#heartbeat_timeoutInteger

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

Returns:

  • (Integer)

Raises:



2082
2083
2084
2085
2086
2087
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2082

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

#heartbeat_ttlInteger

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

Returns:

  • (Integer)

Raises:



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

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

#hwmInteger

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

Returns:

  • (Integer)

Raises:



4696
4697
4698
4699
4700
4701
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4696

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:



4858
4859
4860
4861
4862
4863
4864
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4858

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

#immediateInteger

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

Returns:

  • (Integer)

Raises:



3988
3989
3990
3991
3992
3993
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3988

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

#in_batch_sizeInteger

Get socket option ‘in_batch_size`. Available from libzmq 4.3.0.

Returns:

  • (Integer)

Raises:



1351
1352
1353
1354
1355
1356
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1351

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

#invert_matchingInteger

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

Returns:

  • (Integer)

Raises:



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

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

#ipv4onlyInteger

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

Returns:

  • (Integer)

Raises:



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

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

#ipv6Integer

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

Returns:

  • (Integer)

Raises:



3934
3935
3936
3937
3938
3939
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3934

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:



867
868
869
870
871
872
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 867

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:



4557
4558
4559
4560
4561
4562
4563
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4557

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:



894
895
896
897
898
899
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 894

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

#lingerInteger

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

Returns:

  • (Integer)

Raises:



5344
5345
5346
5347
5348
5349
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5344

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

#loopback_fastpathInteger

Get socket option ‘loopback_fastpath`. Available from libzmq 4.3.0.

Returns:

  • (Integer)

Raises:



1704
1705
1706
1707
1708
1709
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1704

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

#maxmsgsizeInteger

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

Returns:

  • (Integer)

Raises:



4150
4151
4152
4153
4154
4155
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4150

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

#mcast_loopInteger

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

Returns:

  • (Integer)

Raises:



5074
5075
5076
5077
5078
5079
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5074

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

#mechanismInteger

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

Returns:

  • (Integer)

Raises:



3234
3235
3236
3237
3238
3239
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3234

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

#metadata::FFI::AutoPointer

Get socket option ‘metadata`. Available from libzmq 4.3.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



1650
1651
1652
1653
1654
1655
1656
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1650

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

#multicast_hopsInteger

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

Returns:

  • (Integer)

Raises:



4204
4205
4206
4207
4208
4209
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4204

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

#multicast_loopInteger

Get socket option ‘multicast_loop`. Available from libzmq 4.3.0.

Returns:

  • (Integer)

Raises:



1596
1597
1598
1599
1600
1601
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1596

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

#multicast_maxtpduInteger

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

Returns:

  • (Integer)

Raises:



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

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

#null?Boolean

Returns:

  • (Boolean)


44
45
46
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 44

def null?
  !@ptr or @ptr.null?
end

#out_batch_sizeInteger

Get socket option ‘out_batch_size`. Available from libzmq 4.3.0.

Returns:

  • (Integer)

Raises:



1297
1298
1299
1300
1301
1302
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1297

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

#plain_password::FFI::AutoPointer

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

Returns:

  • (::FFI::AutoPointer)

Raises:



3367
3368
3369
3370
3371
3372
3373
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3367

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_serverInteger

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

Returns:

  • (Integer)

Raises:



3259
3260
3261
3262
3263
3264
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3259

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:



3313
3314
3315
3316
3317
3318
3319
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3313

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

#priorityInteger

Get socket option ‘priority`. Available from libzmq 4.3.0.

Returns:

  • (Integer)

Raises:



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

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

#rateInteger

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

Returns:

  • (Integer)

Raises:



4912
4913
4914
4915
4916
4917
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4912

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

#rcvbufInteger

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

Returns:

  • (Integer)

Raises:



5290
5291
5292
5293
5294
5295
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5290

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

#rcvhwmInteger

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

Returns:

  • (Integer)

Raises:



4096
4097
4098
4099
4100
4101
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4096

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

#rcvmoreInteger

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

Returns:

  • (Integer)

Raises:



5639
5640
5641
5642
5643
5644
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5639

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

#rcvtimeoInteger

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

Returns:

  • (Integer)

Raises:



5128
5129
5130
5131
5132
5133
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5128

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

#reconnect_ivlInteger

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

Returns:

  • (Integer)

Raises:



5398
5399
5400
5401
5402
5403
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5398

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

#reconnect_ivl_maxInteger

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

Returns:

  • (Integer)

Raises:



5452
5453
5454
5455
5456
5457
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5452

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

#reconnect_stopInteger

Get socket option ‘reconnect_stop`. Available from libzmq 4.3.0.

Returns:

  • (Integer)

Raises:



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

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

#recovery_ivlInteger

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

Returns:

  • (Integer)

Raises:



4966
4967
4968
4969
4970
4971
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4966

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

#recovery_ivl_msecInteger

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

Returns:

  • (Integer)

Raises:



5020
5021
5022
5023
5024
5025
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5020

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)
l = zlistx_t ** (creates zlistx) (DRAFT)
p = void ** (stores pointer)
m = zmsg_t ** (creates a zmsg with the remaining 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:



515
516
517
518
519
520
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 515

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

#router_notifyInteger

Get socket option ‘router_notify`. Available from libzmq 4.3.0.

Returns:

  • (Integer)

Raises:



1542
1543
1544
1545
1546
1547
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1542

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

#routing_idInteger

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:



724
725
726
727
728
729
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 724

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 *
l = zlistx_t * (DRAFT)
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:



405
406
407
408
409
410
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 405

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:



4830
4831
4832
4833
4834
4835
4836
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4830

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:



5532
5533
5534
5535
5536
5537
5538
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5532

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_bindtodevice(bindtodevice) ⇒ void

This method returns an undefined value.

Set socket option ‘bindtodevice`. Available from libzmq 4.3.0.

Parameters:

  • bindtodevice (String, #to_s, nil)

Raises:



1948
1949
1950
1951
1952
1953
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1948

def set_bindtodevice(bindtodevice)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_bindtodevice(self_p, bindtodevice)
  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:



3152
3153
3154
3155
3156
3157
3158
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3152

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:



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

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:



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

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:



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

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:



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

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:



3530
3531
3532
3533
3534
3535
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3530

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:



3584
3585
3586
3587
3588
3589
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3584

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:



3611
3612
3613
3614
3615
3616
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3611

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:



3447
3448
3449
3450
3451
3452
3453
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3447

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:



3665
3666
3667
3668
3669
3670
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3665

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:



3692
3693
3694
3695
3696
3697
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3692

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:



4668
4669
4670
4671
4672
4673
4674
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4668

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_disconnect_msg(disconnect_msg) ⇒ void

This method returns an undefined value.

Set socket option ‘disconnect_msg`. Available from libzmq 4.3.0.

Parameters:

Raises:



1132
1133
1134
1135
1136
1137
1138
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1132

def set_disconnect_msg(disconnect_msg)
  raise DestroyedError unless @ptr
  self_p = @ptr
  disconnect_msg = disconnect_msg.__ptr if disconnect_msg
  result = ::CZMQ::FFI.zsock_set_disconnect_msg(self_p, disconnect_msg)
  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:



3798
3799
3800
3801
3802
3803
3804
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3798

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:



3854
3855
3856
3857
3858
3859
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3854

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_principal_nametype(gssapi_principal_nametype) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_principal_nametype`. Available from libzmq 4.3.0.

Parameters:

  • gssapi_principal_nametype (Integer, #to_int, #to_i)

Raises:



1838
1839
1840
1841
1842
1843
1844
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1838

def set_gssapi_principal_nametype(gssapi_principal_nametype)
  raise DestroyedError unless @ptr
  self_p = @ptr
  gssapi_principal_nametype = Integer(gssapi_principal_nametype)
  result = ::CZMQ::FFI.zsock_set_gssapi_principal_nametype(self_p, gssapi_principal_nametype)
  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:



3744
3745
3746
3747
3748
3749
3750
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3744

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:



3908
3909
3910
3911
3912
3913
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3908

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_gssapi_service_principal_nametype(gssapi_service_principal_nametype) ⇒ void

This method returns an undefined value.

Set socket option ‘gssapi_service_principal_nametype`. Available from libzmq 4.3.0.

Parameters:

  • gssapi_service_principal_nametype (Integer, #to_int, #to_i)

Raises:



1892
1893
1894
1895
1896
1897
1898
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1892

def set_gssapi_service_principal_nametype(gssapi_service_principal_nametype)
  raise DestroyedError unless @ptr
  self_p = @ptr
  gssapi_service_principal_nametype = Integer(gssapi_service_principal_nametype)
  result = ::CZMQ::FFI.zsock_set_gssapi_service_principal_nametype(self_p, gssapi_service_principal_nametype)
  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:



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

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:



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

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:



2108
2109
2110
2111
2112
2113
2114
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2108

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:



2054
2055
2056
2057
2058
2059
2060
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2054

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_hello_msg(hello_msg) ⇒ void

This method returns an undefined value.

Set socket option ‘hello_msg`. Available from libzmq 4.3.0.

Parameters:

Raises:



1103
1104
1105
1106
1107
1108
1109
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1103

def set_hello_msg(hello_msg)
  raise DestroyedError unless @ptr
  self_p = @ptr
  hello_msg = hello_msg.__ptr if hello_msg
  result = ::CZMQ::FFI.zsock_set_hello_msg(self_p, hello_msg)
  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:



4722
4723
4724
4725
4726
4727
4728
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4722

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:



4886
4887
4888
4889
4890
4891
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4886

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:



4014
4015
4016
4017
4018
4019
4020
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4014

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_in_batch_size(in_batch_size) ⇒ void

This method returns an undefined value.

Set socket option ‘in_batch_size`. Available from libzmq 4.3.0.

Parameters:

  • in_batch_size (Integer, #to_int, #to_i)

Raises:



1377
1378
1379
1380
1381
1382
1383
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1377

def set_in_batch_size(in_batch_size)
  raise DestroyedError unless @ptr
  self_p = @ptr
  in_batch_size = Integer(in_batch_size)
  result = ::CZMQ::FFI.zsock_set_in_batch_size(self_p, in_batch_size)
  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:



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

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:



4639
4640
4641
4642
4643
4644
4645
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4639

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:



3960
3961
3962
3963
3964
3965
3966
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3960

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:



5370
5371
5372
5373
5374
5375
5376
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5370

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_loopback_fastpath(loopback_fastpath) ⇒ void

This method returns an undefined value.

Set socket option ‘loopback_fastpath`. Available from libzmq 4.3.0.

Parameters:

  • loopback_fastpath (Integer, #to_int, #to_i)

Raises:



1730
1731
1732
1733
1734
1735
1736
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1730

def set_loopback_fastpath(loopback_fastpath)
  raise DestroyedError unless @ptr
  self_p = @ptr
  loopback_fastpath = Integer(loopback_fastpath)
  result = ::CZMQ::FFI.zsock_set_loopback_fastpath(self_p, loopback_fastpath)
  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:



4176
4177
4178
4179
4180
4181
4182
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4176

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:



5100
5101
5102
5103
5104
5105
5106
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5100

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_metadata(metadata) ⇒ void

This method returns an undefined value.

Set socket option ‘metadata`. Available from libzmq 4.3.0.

Parameters:

  • metadata (String, #to_s, nil)

Raises:



1678
1679
1680
1681
1682
1683
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1678

def ()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.(self_p, )
  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:



4230
4231
4232
4233
4234
4235
4236
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4230

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_loop(multicast_loop) ⇒ void

This method returns an undefined value.

Set socket option ‘multicast_loop`. Available from libzmq 4.3.0.

Parameters:

  • multicast_loop (Integer, #to_int, #to_i)

Raises:



1622
1623
1624
1625
1626
1627
1628
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1622

def set_multicast_loop(multicast_loop)
  raise DestroyedError unless @ptr
  self_p = @ptr
  multicast_loop = Integer(multicast_loop)
  result = ::CZMQ::FFI.zsock_set_multicast_loop(self_p, multicast_loop)
  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:



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

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_only_first_subscribe(only_first_subscribe) ⇒ void

This method returns an undefined value.

Set socket option ‘only_first_subscribe`. Available from libzmq 4.3.0.

Parameters:

  • only_first_subscribe (Integer, #to_int, #to_i)

Raises:



1074
1075
1076
1077
1078
1079
1080
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1074

def set_only_first_subscribe(only_first_subscribe)
  raise DestroyedError unless @ptr
  self_p = @ptr
  only_first_subscribe = Integer(only_first_subscribe)
  result = ::CZMQ::FFI.zsock_set_only_first_subscribe(self_p, only_first_subscribe)
  result
end

#set_out_batch_size(out_batch_size) ⇒ void

This method returns an undefined value.

Set socket option ‘out_batch_size`. Available from libzmq 4.3.0.

Parameters:

  • out_batch_size (Integer, #to_int, #to_i)

Raises:



1323
1324
1325
1326
1327
1328
1329
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1323

def set_out_batch_size(out_batch_size)
  raise DestroyedError unless @ptr
  self_p = @ptr
  out_batch_size = Integer(out_batch_size)
  result = ::CZMQ::FFI.zsock_set_out_batch_size(self_p, out_batch_size)
  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:



3395
3396
3397
3398
3399
3400
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3395

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:



3285
3286
3287
3288
3289
3290
3291
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3285

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:



3341
3342
3343
3344
3345
3346
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3341

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_priority(priority) ⇒ void

This method returns an undefined value.

Set socket option ‘priority`. Available from libzmq 4.3.0.

Parameters:

  • priority (Integer, #to_int, #to_i)

Raises:



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

def set_priority(priority)
  raise DestroyedError unless @ptr
  self_p = @ptr
  priority = Integer(priority)
  result = ::CZMQ::FFI.zsock_set_priority(self_p, priority)
  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:



3065
3066
3067
3068
3069
3070
3071
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3065

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:



4938
4939
4940
4941
4942
4943
4944
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4938

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:



5316
5317
5318
5319
5320
5321
5322
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5316

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:



4122
4123
4124
4125
4126
4127
4128
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4122

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:



5154
5155
5156
5157
5158
5159
5160
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5154

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:



5424
5425
5426
5427
5428
5429
5430
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5424

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:



5478
5479
5480
5481
5482
5483
5484
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5478

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_reconnect_stop(reconnect_stop) ⇒ void

This method returns an undefined value.

Set socket option ‘reconnect_stop`. Available from libzmq 4.3.0.

Parameters:

  • reconnect_stop (Integer, #to_int, #to_i)

Raises:



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

def set_reconnect_stop(reconnect_stop)
  raise DestroyedError unless @ptr
  self_p = @ptr
  reconnect_stop = Integer(reconnect_stop)
  result = ::CZMQ::FFI.zsock_set_reconnect_stop(self_p, reconnect_stop)
  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:



4992
4993
4994
4995
4996
4997
4998
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4992

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:



5046
5047
5048
5049
5050
5051
5052
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5046

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:



3123
3124
3125
3126
3127
3128
3129
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3123

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:



3094
3095
3096
3097
3098
3099
3100
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3094

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:



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

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:



3036
3037
3038
3039
3040
3041
3042
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3036

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_notify(router_notify) ⇒ void

This method returns an undefined value.

Set socket option ‘router_notify`. Available from libzmq 4.3.0.

Parameters:

  • router_notify (Integer, #to_int, #to_i)

Raises:



1568
1569
1570
1571
1572
1573
1574
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1568

def set_router_notify(router_notify)
  raise DestroyedError unless @ptr
  self_p = @ptr
  router_notify = Integer(router_notify)
  result = ::CZMQ::FFI.zsock_set_router_notify(self_p, router_notify)
  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:



4585
4586
4587
4588
4589
4590
4591
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4585

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:



736
737
738
739
740
741
742
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 736

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:



5262
5263
5264
5265
5266
5267
5268
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5262

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:



4068
4069
4070
4071
4072
4073
4074
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4068

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:



5208
5209
5210
5211
5212
5213
5214
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5208

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_password(socks_password) ⇒ void

This method returns an undefined value.

Set socket option ‘socks_password`. Available from libzmq 4.3.0.

Parameters:

  • socks_password (String, #to_s, nil)

Raises:



1433
1434
1435
1436
1437
1438
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1433

def set_socks_password(socks_password)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_socks_password(self_p, socks_password)
  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:



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

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_socks_username(socks_username) ⇒ void

This method returns an undefined value.

Set socket option ‘socks_username`. Available from libzmq 4.3.0.

Parameters:

  • socks_username (String, #to_s, nil)

Raises:



1487
1488
1489
1490
1491
1492
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1487

def set_socks_username(socks_username)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_socks_username(self_p, socks_username)
  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:



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

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:



5561
5562
5563
5564
5565
5566
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5561

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:



4776
4777
4778
4779
4780
4781
4782
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4776

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:



4531
4532
4533
4534
4535
4536
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4531

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:



4313
4314
4315
4316
4317
4318
4319
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4313

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:



4421
4422
4423
4424
4425
4426
4427
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4421

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:



4367
4368
4369
4370
4371
4372
4373
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4367

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:



4475
4476
4477
4478
4479
4480
4481
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4475

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:



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

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:



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

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_unboundedvoid

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:



749
750
751
752
753
754
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 749

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:



5588
5589
5590
5591
5592
5593
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5588

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:



2162
2163
2164
2165
2166
2167
2168
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2162

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:



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

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:



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

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:



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

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:



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

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_wss_cert_pem(wss_cert_pem) ⇒ void

This method returns an undefined value.

Set socket option ‘wss_cert_pem`. Available from libzmq 4.3.0.

Parameters:

  • wss_cert_pem (String, #to_s, nil)

Raises:



1244
1245
1246
1247
1248
1249
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1244

def set_wss_cert_pem(wss_cert_pem)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_wss_cert_pem(self_p, wss_cert_pem)
  result
end

#set_wss_hostname(wss_hostname) ⇒ void

This method returns an undefined value.

Set socket option ‘wss_hostname`. Available from libzmq 4.3.0.

Parameters:

  • wss_hostname (String, #to_s, nil)

Raises:



1190
1191
1192
1193
1194
1195
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1190

def set_wss_hostname(wss_hostname)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_wss_hostname(self_p, wss_hostname)
  result
end

#set_wss_key_pem(wss_key_pem) ⇒ void

This method returns an undefined value.

Set socket option ‘wss_key_pem`. Available from libzmq 4.3.0.

Parameters:

  • wss_key_pem (String, #to_s, nil)

Raises:



1271
1272
1273
1274
1275
1276
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1271

def set_wss_key_pem(wss_key_pem)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_wss_key_pem(self_p, wss_key_pem)
  result
end

#set_wss_trust_pem(wss_trust_pem) ⇒ void

This method returns an undefined value.

Set socket option ‘wss_trust_pem`. Available from libzmq 4.3.0.

Parameters:

  • wss_trust_pem (String, #to_s, nil)

Raises:



1217
1218
1219
1220
1221
1222
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1217

def set_wss_trust_pem(wss_trust_pem)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_wss_trust_pem(self_p, wss_trust_pem)
  result
end

#set_wss_trust_system(wss_trust_system) ⇒ void

This method returns an undefined value.

Set socket option ‘wss_trust_system`. Available from libzmq 4.3.0.

Parameters:

  • wss_trust_system (Integer, #to_int, #to_i)

Raises:



1161
1162
1163
1164
1165
1166
1167
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1161

def set_wss_trust_system(wss_trust_system)
  raise DestroyedError unless @ptr
  self_p = @ptr
  wss_trust_system = Integer(wss_trust_system)
  result = ::CZMQ::FFI.zsock_set_wss_trust_system(self_p, wss_trust_system)
  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:



2191
2192
2193
2194
2195
2196
2197
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2191

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_manual_last_value(xpub_manual_last_value) ⇒ void

This method returns an undefined value.

Set socket option ‘xpub_manual_last_value`. Available from libzmq 4.3.0.

Parameters:

  • xpub_manual_last_value (Integer, #to_int, #to_i)

Raises:



1514
1515
1516
1517
1518
1519
1520
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1514

def set_xpub_manual_last_value(xpub_manual_last_value)
  raise DestroyedError unless @ptr
  self_p = @ptr
  xpub_manual_last_value = Integer(xpub_manual_last_value)
  result = ::CZMQ::FFI.zsock_set_xpub_manual_last_value(self_p, xpub_manual_last_value)
  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:



3007
3008
3009
3010
3011
3012
3013
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3007

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:



4259
4260
4261
4262
4263
4264
4265
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4259

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:



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

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:



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

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:



3208
3209
3210
3211
3212
3213
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3208

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

#set_zap_enforce_domain(zap_enforce_domain) ⇒ void

This method returns an undefined value.

Set socket option ‘zap_enforce_domain`. Available from libzmq 4.3.0.

Parameters:

  • zap_enforce_domain (Integer, #to_int, #to_i)

Raises:



1784
1785
1786
1787
1788
1789
1790
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1784

def set_zap_enforce_domain(zap_enforce_domain)
  raise DestroyedError unless @ptr
  self_p = @ptr
  zap_enforce_domain = Integer(zap_enforce_domain)
  result = ::CZMQ::FFI.zsock_set_zap_enforce_domain(self_p, zap_enforce_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:



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

def signal(status)
  raise DestroyedError unless @ptr
  self_p = @ptr
  status = Integer(status)
  result = ::CZMQ::FFI.zsock_signal(self_p, status)
  result
end

#sndbufInteger

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

Returns:

  • (Integer)

Raises:



5236
5237
5238
5239
5240
5241
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5236

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

#sndhwmInteger

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

Returns:

  • (Integer)

Raises:



4042
4043
4044
4045
4046
4047
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4042

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

#sndtimeoInteger

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

Returns:

  • (Integer)

Raises:



5182
5183
5184
5185
5186
5187
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5182

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

#socks_password::FFI::AutoPointer

Get socket option ‘socks_password`. Available from libzmq 4.3.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



1405
1406
1407
1408
1409
1410
1411
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1405

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

#socks_proxy::FFI::AutoPointer

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

Returns:

  • (::FFI::AutoPointer)

Raises:



2952
2953
2954
2955
2956
2957
2958
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2952

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

#socks_username::FFI::AutoPointer

Get socket option ‘socks_username`. Available from libzmq 4.3.0.

Returns:

  • (::FFI::AutoPointer)

Raises:



1459
1460
1461
1462
1463
1464
1465
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1459

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

#swapInteger

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

Returns:

  • (Integer)

Raises:



4750
4751
4752
4753
4754
4755
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4750

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:



4503
4504
4505
4506
4507
4508
4509
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4503

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_keepaliveInteger

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

Returns:

  • (Integer)

Raises:



4287
4288
4289
4290
4291
4292
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4287

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

#tcp_keepalive_cntInteger

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

Returns:

  • (Integer)

Raises:



4395
4396
4397
4398
4399
4400
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4395

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

#tcp_keepalive_idleInteger

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

Returns:

  • (Integer)

Raises:



4341
4342
4343
4344
4345
4346
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4341

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

#tcp_keepalive_intvlInteger

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

Returns:

  • (Integer)

Raises:



4449
4450
4451
4452
4453
4454
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4449

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

#tcp_maxrtInteger

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

Returns:

  • (Integer)

Raises:



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

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

#thread_safeInteger

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

Returns:

  • (Integer)

Raises:



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

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

#tosInteger

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

Returns:

  • (Integer)

Raises:



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

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

#typeInteger

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

Returns:

  • (Integer)

Raises:



5614
5615
5616
5617
5618
5619
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5614

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

#type_strString

Returns socket type as printable constant string.

Returns:

  • (String)

Raises:



367
368
369
370
371
372
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 367

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:



312
313
314
315
316
317
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 312

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

#use_fdInteger

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

Returns:

  • (Integer)

Raises:



2136
2137
2138
2139
2140
2141
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2136

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

#vmci_buffer_max_sizeInteger

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

Returns:

  • (Integer)

Raises:



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

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_sizeInteger

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

Returns:

  • (Integer)

Raises:



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

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_sizeInteger

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

Returns:

  • (Integer)

Raises:



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

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

#vmci_connect_timeoutInteger

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

Returns:

  • (Integer)

Raises:



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

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:



570
571
572
573
574
575
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 570

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:



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

def vsend(picture, argptr)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_vsend(self_p, picture, argptr)
  result
end

#waitInteger

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:



812
813
814
815
816
817
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 812

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:



3180
3181
3182
3183
3184
3185
3186
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3180

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

#zap_enforce_domainInteger

Get socket option ‘zap_enforce_domain`. Available from libzmq 4.3.0.

Returns:

  • (Integer)

Raises:



1758
1759
1760
1761
1762
1763
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1758

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