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)


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

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)


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

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)


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

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)


697
698
699
700
701
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 697

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)


638
639
640
641
642
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 638

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)


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

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

.create_finalizer_for(ptr) ⇒ Proc

Parameters:

  • ptr (::FFI::Pointer)

Returns:

  • (Proc)


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

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

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

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

This is the polymorphic version of #curve_publickey.

Parameters:

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

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer)


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

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)


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

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)


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

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)


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

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)


5110
5111
5112
5113
5114
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5110

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)


5085
5086
5087
5088
5089
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5085

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



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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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

.invert_matching(self_p) ⇒ Integer

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

This is the polymorphic version of #invert_matching.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


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

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)


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

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)


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

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)


904
905
906
907
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 904

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


1912
1913
1914
1915
1916
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1912

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

.new(type) ⇒ CZMQ::Zsock

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

Parameters:

  • type (Integer, #to_int, #to_i)

Returns:

  • (CZMQ::Zsock)


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

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

.new_client(endpoint) ⇒ CZMQ::Zsock

Create a CLIENT socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_dealer(endpoint) ⇒ CZMQ::Zsock

Create a DEALER socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_dish(endpoint) ⇒ CZMQ::Zsock

Create a DISH socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_gather(endpoint) ⇒ CZMQ::Zsock

Create a GATHER socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_pair(endpoint) ⇒ CZMQ::Zsock

Create a PAIR socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_pub(endpoint) ⇒ CZMQ::Zsock

Create a PUB socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_pull(endpoint) ⇒ CZMQ::Zsock

Create a PULL socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_push(endpoint) ⇒ CZMQ::Zsock

Create a PUSH socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_radio(endpoint) ⇒ CZMQ::Zsock

Create a RADIO socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_rep(endpoint) ⇒ CZMQ::Zsock

Create a REP socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_req(endpoint) ⇒ CZMQ::Zsock

Create a REQ socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_router(endpoint) ⇒ CZMQ::Zsock

Create a ROUTER socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_scatter(endpoint) ⇒ CZMQ::Zsock

Create a SCATTER socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_server(endpoint) ⇒ CZMQ::Zsock

Create a SERVER socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_stream(endpoint) ⇒ CZMQ::Zsock

Create a STREAM socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

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

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

Parameters:

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

Returns:

  • (CZMQ::Zsock)


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

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

.new_xpub(endpoint) ⇒ CZMQ::Zsock

Create an XPUB socket. Default action is bind.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

.new_xsub(endpoint) ⇒ CZMQ::Zsock

Create an XSUB socket. Default action is connect.

Parameters:

  • endpoint (String, #to_s, nil)

Returns:

  • (CZMQ::Zsock)


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

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

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

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

This is the polymorphic version of #plain_password.

Parameters:

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

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer)


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

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)


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

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)


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

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

.rate(self_p) ⇒ Integer

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

This is the polymorphic version of #rate.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


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

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)


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

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)


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

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)


5060
5061
5062
5063
5064
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5060

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)


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

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)


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

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)


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

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

.recovery_ivl(self_p) ⇒ Integer

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

This is the polymorphic version of #recovery_ivl.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


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

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)


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

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)


540
541
542
543
544
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 540

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)


916
917
918
919
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 916

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)


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

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)


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

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)


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

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)


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

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)


1370
1371
1372
1373
1374
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1370

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)


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

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)


2267
2268
2269
2270
2271
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2267

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)


2294
2295
2296
2297
2298
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2294

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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

.set_gssapi_plaintext(self_p, gssapi_plaintext) ⇒ void

This method returns an undefined value.

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

This is the polymorphic version of #set_gssapi_plaintext.

Parameters:

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

    object reference to use this method on

  • gssapi_plaintext (Integer, #to_int, #to_i)


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

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)


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

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)


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

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)


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

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)


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

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)


1315
1316
1317
1318
1319
1320
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1315

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)


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

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)


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

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)


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

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)


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

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

.set_hwm(self_p, hwm) ⇒ void

This method returns an undefined value.

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

This is the polymorphic version of #set_hwm.

Parameters:

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

    object reference to use this method on

  • hwm (Integer, #to_int, #to_i)


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

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)


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

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)


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

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

.set_invert_matching(self_p, invert_matching) ⇒ void

This method returns an undefined value.

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

This is the polymorphic version of #set_invert_matching.

Parameters:

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

    object reference to use this method on

  • invert_matching (Integer, #to_int, #to_i)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


1940
1941
1942
1943
1944
1945
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1940

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

.set_plain_password(self_p, plain_password) ⇒ void

This method returns an undefined value.

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

This is the polymorphic version of #set_plain_password.

Parameters:

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

    object reference to use this method on

  • plain_password (String, #to_s, nil)


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

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)


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

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)


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

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

.set_probe_router(self_p, probe_router) ⇒ void

This method returns an undefined value.

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

This is the polymorphic version of #set_probe_router.

Parameters:

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

    object reference to use this method on

  • probe_router (Integer, #to_int, #to_i)


2488
2489
2490
2491
2492
2493
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2488

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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

.set_recovery_ivl(self_p, recovery_ivl) ⇒ void

This method returns an undefined value.

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

This is the polymorphic version of #set_recovery_ivl.

Parameters:

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

    object reference to use this method on

  • recovery_ivl (Integer, #to_int, #to_i)


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

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)


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

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)


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

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)


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

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)


2239
2240
2241
2242
2243
2244
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2239

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)


2459
2460
2461
2462
2463
2464
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2459

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)


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

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)


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

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)


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

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)


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

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)


4631
4632
4633
4634
4635
4636
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4631

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

.set_socks_proxy(self_p, socks_proxy) ⇒ void

This method returns an undefined value.

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

This is the polymorphic version of #set_socks_proxy.

Parameters:

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

    object reference to use this method on

  • socks_proxy (String, #to_s, nil)


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

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

.set_stream_notify(self_p, stream_notify) ⇒ void

This method returns an undefined value.

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

This is the polymorphic version of #set_stream_notify.

Parameters:

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

    object reference to use this method on

  • stream_notify (Integer, #to_int, #to_i)


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

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)


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

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)


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

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)


3953
3954
3955
3956
3957
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3953

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)


3736
3737
3738
3739
3740
3741
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3736

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)


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

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)


3790
3791
3792
3793
3794
3795
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3790

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)


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

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)


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

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)


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

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



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

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)


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

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)


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

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)


2102
2103
2104
2105
2106
2107
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2102

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)


2048
2049
2050
2051
2052
2053
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2048

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)


1994
1995
1996
1997
1998
1999
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1994

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)


2156
2157
2158
2159
2160
2161
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2156

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

.set_xpub_manual(self_p, xpub_manual) ⇒ void

This method returns an undefined value.

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

This is the polymorphic version of #set_xpub_manual.

Parameters:

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

    object reference to use this method on

  • xpub_manual (Integer, #to_int, #to_i)


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

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

.set_xpub_nodrop(self_p, xpub_nodrop) ⇒ void

This method returns an undefined value.

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

This is the polymorphic version of #set_xpub_nodrop.

Parameters:

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

    object reference to use this method on

  • xpub_nodrop (Integer, #to_int, #to_i)


2430
2431
2432
2433
2434
2435
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2430

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)


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

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)


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

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)


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

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)


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

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)


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

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)


782
783
784
785
786
787
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 782

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)


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

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)


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

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)


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

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

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

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

This is the polymorphic version of #socks_proxy.

Parameters:

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

    object reference to use this method on

Returns:

  • (::FFI::AutoPointer)


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

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

.swap(self_p) ⇒ Integer

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

This is the polymorphic version of #swap.

Parameters:

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

    object reference to use this method on

Returns:

  • (Integer)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


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

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)


5120
5121
5122
5123
5124
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5120

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)


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

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)


2182
2183
2184
2185
2186
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2182

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)


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

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)


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

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)


2074
2075
2076
2077
2078
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2074

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)


2020
2021
2022
2023
2024
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2020

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)


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

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)


2128
2129
2130
2131
2132
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2128

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)


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

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)


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

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)


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

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)


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

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)


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

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:



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

def __ptr
  raise DestroyedError unless @ptr
  @ptr
end

#__ptr_give_ref::FFI::MemoryPointer

Note:

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

Nullify internal pointer and return pointer pointer.

Returns:

  • (::FFI::MemoryPointer)

    the pointer pointing to a pointer pointing to the native object

Raises:



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

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

#__undef_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.



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

def __undef_finalizer
  ObjectSpace.undefine_finalizer self
  @finalizer = nil
end

#affinityInteger

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

Returns:

  • (Integer)

Raises:



4210
4211
4212
4213
4214
4215
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4210

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

#attach(endpoints, serverish) ⇒ Integer

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

Parameters:

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

Returns:

  • (Integer)

Raises:



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

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

#backlogInteger

Get socket option ‘backlog`. 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 backlog()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_backlog(self_p)
  result
end

#bind(format, *args) ⇒ Integer

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

Examples:

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

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

Parameters:

Returns:

  • (Integer)

Raises:



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

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

#bindtodevice::FFI::AutoPointer

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

Returns:

  • (::FFI::AutoPointer)

Raises:



1326
1327
1328
1329
1330
1331
1332
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1326

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:



665
666
667
668
669
670
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 665

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:



602
603
604
605
606
607
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 602

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

#connect(format, *args) ⇒ Integer

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

Parameters:

Returns:

  • (Integer)

Raises:



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

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

#connect_timeoutInteger

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

Returns:

  • (Integer)

Raises:



1764
1765
1766
1767
1768
1769
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1764

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:



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

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:



2962
2963
2964
2965
2966
2967
2968
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2962

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:



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

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:



3043
3044
3045
3046
3047
3048
3049
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3043

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.



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

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

#disconnect(format, *args) ⇒ Integer

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

Parameters:

Returns:

  • (Integer)

Raises:



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

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

#endpointString

Returns last bound endpoint, if any.

Returns:

  • (String)

Raises:



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

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

#eventsInteger

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

Returns:

  • (Integer)

Raises:



5095
5096
5097
5098
5099
5100
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5095

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:



5070
5071
5072
5073
5074
5075
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 5070

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:



823
824
825
826
827
828
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 823

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:



3178
3179
3180
3181
3182
3183
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3178

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



924
925
926
927
928
929
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 924

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:



1380
1381
1382
1383
1384
1385
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1380

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:



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

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:



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

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:



4102
4103
4104
4105
4106
4107
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4102

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:



4264
4265
4266
4267
4268
4269
4270
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4264

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:



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

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

#invert_matchingInteger

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

Returns:

  • (Integer)

Raises:



1681
1682
1683
1684
1685
1686
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1681

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:



4019
4020
4021
4022
4023
4024
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4019

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:



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

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:



850
851
852
853
854
855
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 850

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:



3963
3964
3965
3966
3967
3968
3969
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3963

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:



877
878
879
880
881
882
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 877

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:



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

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:



1110
1111
1112
1113
1114
1115
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1110

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:



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

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:



4480
4481
4482
4483
4484
4485
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4480

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:



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

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:



1056
1057
1058
1059
1060
1061
1062
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1056

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:



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

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:



1002
1003
1004
1005
1006
1007
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1002

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:



1897
1898
1899
1900
1901
1902
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1897

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

#null?Boolean

Returns:

  • (Boolean)


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

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

#plain_password::FFI::AutoPointer

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

Returns:

  • (::FFI::AutoPointer)

Raises:



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

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:



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

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:



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

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

#rateInteger

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

Returns:

  • (Integer)

Raises:



4318
4319
4320
4321
4322
4323
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4318

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:



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

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:



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

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:



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

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:



4534
4535
4536
4537
4538
4539
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4534

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:



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

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:



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

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

#recovery_ivlInteger

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

Returns:

  • (Integer)

Raises:



4372
4373
4374
4375
4376
4377
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4372

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:



4426
4427
4428
4429
4430
4431
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4426

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:



498
499
500
501
502
503
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 498

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:



948
949
950
951
952
953
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 948

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:



707
708
709
710
711
712
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 707

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:



388
389
390
391
392
393
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 388

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:



4236
4237
4238
4239
4240
4241
4242
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4236

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:



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

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:



1354
1355
1356
1357
1358
1359
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1354

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:



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

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:



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

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:



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

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:



1790
1791
1792
1793
1794
1795
1796
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1790

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:



2909
2910
2911
2912
2913
2914
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2909

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:



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

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:



2990
2991
2992
2993
2994
2995
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2990

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:



3017
3018
3019
3020
3021
3022
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3017

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:



2853
2854
2855
2856
2857
2858
2859
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2853

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:



3071
3072
3073
3074
3075
3076
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3071

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:



3098
3099
3100
3101
3102
3103
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3098

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:



4074
4075
4076
4077
4078
4079
4080
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4074

def set_delay_attach_on_connect(delay_attach_on_connect)
  raise DestroyedError unless @ptr
  self_p = @ptr
  delay_attach_on_connect = Integer(delay_attach_on_connect)
  result = ::CZMQ::FFI.zsock_set_delay_attach_on_connect(self_p, delay_attach_on_connect)
  result
end

#set_gssapi_plaintext(gssapi_plaintext) ⇒ void

This method returns an undefined value.

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

Parameters:

  • gssapi_plaintext (Integer, #to_int, #to_i)

Raises:



3204
3205
3206
3207
3208
3209
3210
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3204

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

def set_heartbeat_ttl(heartbeat_ttl)
  raise DestroyedError unless @ptr
  self_p = @ptr
  heartbeat_ttl = Integer(heartbeat_ttl)
  result = ::CZMQ::FFI.zsock_set_heartbeat_ttl(self_p, heartbeat_ttl)
  result
end

#set_hwm(hwm) ⇒ void

This method returns an undefined value.

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

Parameters:

  • hwm (Integer, #to_int, #to_i)

Raises:



4128
4129
4130
4131
4132
4133
4134
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4128

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:



4292
4293
4294
4295
4296
4297
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4292

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:



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

def set_immediate(immediate)
  raise DestroyedError unless @ptr
  self_p = @ptr
  immediate = Integer(immediate)
  result = ::CZMQ::FFI.zsock_set_immediate(self_p, immediate)
  result
end

#set_invert_matching(invert_matching) ⇒ void

This method returns an undefined value.

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

Parameters:

  • invert_matching (Integer, #to_int, #to_i)

Raises:



1707
1708
1709
1710
1711
1712
1713
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1707

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:



4045
4046
4047
4048
4049
4050
4051
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4045

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:



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

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:



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

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:



1136
1137
1138
1139
1140
1141
1142
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1136

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:



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

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:



4506
4507
4508
4509
4510
4511
4512
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4506

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:



1084
1085
1086
1087
1088
1089
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1084

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:



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

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:



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

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:



1923
1924
1925
1926
1927
1928
1929
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1923

def set_multicast_maxtpdu(multicast_maxtpdu)
  raise DestroyedError unless @ptr
  self_p = @ptr
  multicast_maxtpdu = Integer(multicast_maxtpdu)
  result = ::CZMQ::FFI.zsock_set_multicast_maxtpdu(self_p, multicast_maxtpdu)
  result
end

#set_plain_password(plain_password) ⇒ void

This method returns an undefined value.

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

Parameters:

  • plain_password (String, #to_s, nil)

Raises:



2801
2802
2803
2804
2805
2806
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2801

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:



2691
2692
2693
2694
2695
2696
2697
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2691

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:



2747
2748
2749
2750
2751
2752
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2747

def set_plain_username(plain_username)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_plain_username(self_p, plain_username)
  result
end

#set_probe_router(probe_router) ⇒ void

This method returns an undefined value.

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

Parameters:

  • probe_router (Integer, #to_int, #to_i)

Raises:



2471
2472
2473
2474
2475
2476
2477
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2471

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:



4344
4345
4346
4347
4348
4349
4350
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4344

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:



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

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:



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

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:



4560
4561
4562
4563
4564
4565
4566
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4560

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:



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

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:



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

def set_reconnect_ivl_max(reconnect_ivl_max)
  raise DestroyedError unless @ptr
  self_p = @ptr
  reconnect_ivl_max = Integer(reconnect_ivl_max)
  result = ::CZMQ::FFI.zsock_set_reconnect_ivl_max(self_p, reconnect_ivl_max)
  result
end

#set_recovery_ivl(recovery_ivl) ⇒ void

This method returns an undefined value.

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

Parameters:

  • recovery_ivl (Integer, #to_int, #to_i)

Raises:



4398
4399
4400
4401
4402
4403
4404
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4398

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:



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

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:



2529
2530
2531
2532
2533
2534
2535
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2529

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:



2500
2501
2502
2503
2504
2505
2506
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2500

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:



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

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:



2442
2443
2444
2445
2446
2447
2448
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2442

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:



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

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:



3991
3992
3993
3994
3995
3996
3997
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3991

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:



719
720
721
722
723
724
725
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 719

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:



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

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:



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

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:



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

def set_sndtimeo(sndtimeo)
  raise DestroyedError unless @ptr
  self_p = @ptr
  sndtimeo = Integer(sndtimeo)
  result = ::CZMQ::FFI.zsock_set_sndtimeo(self_p, sndtimeo)
  result
end

#set_socks_proxy(socks_proxy) ⇒ void

This method returns an undefined value.

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

Parameters:

  • socks_proxy (String, #to_s, nil)

Raises:



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

def set_socks_proxy(socks_proxy)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zsock_set_socks_proxy(self_p, socks_proxy)
  result
end

#set_stream_notify(stream_notify) ⇒ void

This method returns an undefined value.

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

Parameters:

  • stream_notify (Integer, #to_int, #to_i)

Raises:



1653
1654
1655
1656
1657
1658
1659
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1653

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:



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

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:



4182
4183
4184
4185
4186
4187
4188
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4182

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:



3937
3938
3939
3940
3941
3942
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3937

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:



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

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:



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

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:



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

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:



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

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:



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

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:



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

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:



732
733
734
735
736
737
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 732

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:



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

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:



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

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:



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

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:



2031
2032
2033
2034
2035
2036
2037
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2031

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:



1977
1978
1979
1980
1981
1982
1983
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1977

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:



2139
2140
2141
2142
2143
2144
2145
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2139

def set_vmci_connect_timeout(vmci_connect_timeout)
  raise DestroyedError unless @ptr
  self_p = @ptr
  vmci_connect_timeout = Integer(vmci_connect_timeout)
  result = ::CZMQ::FFI.zsock_set_vmci_connect_timeout(self_p, vmci_connect_timeout)
  result
end

#set_xpub_manual(xpub_manual) ⇒ void

This method returns an undefined value.

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

Parameters:

  • xpub_manual (Integer, #to_int, #to_i)

Raises:



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

def set_xpub_manual(xpub_manual)
  raise DestroyedError unless @ptr
  self_p = @ptr
  xpub_manual = Integer(xpub_manual)
  result = ::CZMQ::FFI.zsock_set_xpub_manual(self_p, xpub_manual)
  result
end

#set_xpub_nodrop(xpub_nodrop) ⇒ void

This method returns an undefined value.

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

Parameters:

  • xpub_nodrop (Integer, #to_int, #to_i)

Raises:



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

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:



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

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:



1736
1737
1738
1739
1740
1741
1742
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1736

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:



1626
1627
1628
1629
1630
1631
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1626

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:



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

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:



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

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:



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

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:



4642
4643
4644
4645
4646
4647
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4642

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:



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

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:



4588
4589
4590
4591
4592
4593
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4588

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

#socks_proxy::FFI::AutoPointer

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

Returns:

  • (::FFI::AutoPointer)

Raises:



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

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

#swapInteger

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

Returns:

  • (Integer)

Raises:



4156
4157
4158
4159
4160
4161
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 4156

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:



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

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:



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

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:



3801
3802
3803
3804
3805
3806
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3801

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:



3747
3748
3749
3750
3751
3752
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 3747

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:



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

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:



1818
1819
1820
1821
1822
1823
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1818

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:



1872
1873
1874
1875
1876
1877
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1872

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:



2167
2168
2169
2170
2171
2172
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2167

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:



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

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:



350
351
352
353
354
355
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 350

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

#unbind(format, *args) ⇒ Integer

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

Parameters:

Returns:

  • (Integer)

Raises:



295
296
297
298
299
300
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 295

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

#use_fdInteger

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

Returns:

  • (Integer)

Raises:



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

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:



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

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:



2005
2006
2007
2008
2009
2010
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2005

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:



1951
1952
1953
1954
1955
1956
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1951

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:



2113
2114
2115
2116
2117
2118
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 2113

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:



553
554
555
556
557
558
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 553

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:



443
444
445
446
447
448
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 443

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:



795
796
797
798
799
800
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 795

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:



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

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:



1164
1165
1166
1167
1168
1169
# File 'lib/czmq-ffi-gen/czmq/ffi/zsock.rb', line 1164

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