class CZMQ::FFI::Zmsg

working with multipart messages @note This class is 100% generated using zproject.

Public Class Methods

__new()
Alias for: new
create_finalizer_for(ptr) click to toggle source

@param ptr [::FFI::Pointer] @return [Proc]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.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.zmsg_destroy ptr_ptr
  end
end
decode(frame) click to toggle source

Decodes a serialized message frame created by zmsg_encode () and returns a new zmsg_t object. Returns NULL if the frame was badly formatted or there was insufficient memory to work. @param frame [Zframe, #__ptr] @return [CZMQ::Zmsg]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 108
def self.decode(frame)
  frame = frame.__ptr if frame
  ptr = ::CZMQ::FFI.zmsg_decode(frame)
  __new ptr
end
is(self_) click to toggle source

Probe the supplied object, and report if it looks like a zmsg_t.

@param self_ [::FFI::Pointer, to_ptr] @return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 510
def self.is(self_)
  result = ::CZMQ::FFI.zmsg_is(self_)
  result
end
load(file) click to toggle source

Load/append an open file into new message, return the message. Returns NULL if the message could not be loaded. @param file [::FFI::Pointer, to_ptr] @return [CZMQ::Zmsg]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 98
def self.load(file)
  ptr = ::CZMQ::FFI.zmsg_load(file)
  __new ptr
end
new(ptr, finalize = true) click to toggle source

Attaches the pointer ptr to this instance and defines a finalizer for it if necessary. @param ptr [::FFI::Pointer] @param finalize [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.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
new() click to toggle source

Create a new empty message object @return [CZMQ::Zmsg]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 78
def self.new()
  ptr = ::CZMQ::FFI.zmsg_new()
  __new ptr
end
Also aliased as: __new
new_signal(status) click to toggle source

Generate a signal message encoding the given status. A signal is a short message carrying a 1-byte success/failure code (by convention, 0 means OK). Signals are encoded to be distinguishable from “normal” messages. @param status [Integer, to_int, to_i] @return [CZMQ::Zmsg]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 119
def self.new_signal(status)
  status = Integer(status)
  ptr = ::CZMQ::FFI.zmsg_new_signal(status)
  __new ptr
end
recv(source) click to toggle source

Receive message from socket, returns zmsg_t object or NULL if the recv was interrupted. Does a blocking recv. If you want to not block then use the zloop class or zmsg_recv_nowait or zmq_poll to check for socket input before receiving. @param source [::FFI::Pointer, to_ptr] @return [CZMQ::Zmsg]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 89
def self.recv(source)
  ptr = ::CZMQ::FFI.zmsg_recv(source)
  __new ptr
end
send(self_p, dest) click to toggle source

Send message to destination socket, and destroy the message after sending it successfully. If the message has no frames, sends nothing but destroys the message anyhow. Nullifies the caller's reference to the message (as it is a destructor).

@param self_p [#__ptr_give_ref] @param dest [::FFI::Pointer, to_ptr] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 143
def self.send(self_p, dest)
  self_p = self_p.__ptr_give_ref
  result = ::CZMQ::FFI.zmsg_send(self_p, dest)
  result
end
sendm(self_p, dest) click to toggle source

Send message to destination socket as part of a multipart sequence, and destroy the message after sending it successfully. Note that after a zmsg_sendm, you must call zmsg_send or another method that sends a final message part. If the message has no frames, sends nothing but destroys the message anyhow. Nullifies the caller's reference to the message (as it is a destructor).

@param self_p [#__ptr_give_ref] @param dest [::FFI::Pointer, to_ptr] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 159
def self.sendm(self_p, dest)
  self_p = self_p.__ptr_give_ref
  result = ::CZMQ::FFI.zmsg_sendm(self_p, dest)
  result
end
test(verbose) click to toggle source

Self test of this class.

@param verbose [Boolean] @return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 519
def self.test(verbose)
  verbose = !(0==verbose||!verbose) # boolean
  result = ::CZMQ::FFI.zmsg_test(verbose)
  result
end

Public Instance Methods

__ptr() click to toggle source

Return internal pointer @return [::FFI::Pointer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 48
def __ptr
  raise DestroyedError unless @ptr
  @ptr
end
Also aliased as: to_ptr
__ptr_give_ref() click to toggle source

Nullify internal pointer and return pointer pointer. @note This detaches the current instance from the native object

and thus makes it unusable.

@return [::FFI::MemoryPointer] the pointer pointing to a pointer

pointing to the native object
# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 59
def __ptr_give_ref
  raise DestroyedError unless @ptr
  ptr_ptr = ::FFI::MemoryPointer.new :pointer
  ptr_ptr.write_pointer @ptr
  __undef_finalizer if @finalizer
  @ptr = nil
  ptr_ptr
end
__undef_finalizer() click to toggle source

Undefines the finalizer for this object. @note Only use this if you need to and can guarantee that the native

object will be freed by other means.

@return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 71
def __undef_finalizer
  ObjectSpace.undefine_finalizer self
  @finalizer = nil
end
addmem(data, size) click to toggle source

Add block of memory to the end of the message, as a new frame. Returns 0 on success, -1 on error.

@param data [::FFI::Pointer, to_ptr] @param size [Integer, to_int, to_i] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 270
def addmem(data, size)
  raise DestroyedError unless @ptr
  self_p = @ptr
  size = Integer(size)
  result = ::CZMQ::FFI.zmsg_addmem(self_p, data, size)
  result
end
addmsg(msg_p) click to toggle source

Push encoded message as a new frame. Message takes ownership of submessage, so the original is destroyed in this call. Returns 0 on success, -1 on error.

@param msg_p [#__ptr_give_ref] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 346
def addmsg(msg_p)
  raise DestroyedError unless @ptr
  self_p = @ptr
  msg_p = msg_p.__ptr_give_ref
  result = ::CZMQ::FFI.zmsg_addmsg(self_p, msg_p)
  result
end
addstr(string) click to toggle source

Push string as new frame to end of message. Returns 0 on success, -1 on error.

@param string [String, to_s, nil] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 295
def addstr(string)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_addstr(self_p, string)
  result
end
addstrf(format, *args) click to toggle source

Push formatted string as new frame to end of message. Returns 0 on success, -1 on error.

@param format [String, to_s, nil] @param args [Array<Object>] see github.com/ffi/ffi/wiki/examples#using-varargs @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 321
def addstrf(format, *args)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_addstrf(self_p, format, *args)
  result
end
append(frame_p) click to toggle source

Add frame to the end of the message, i.e. after all other frames. Message takes ownership of frame, will destroy it when message is sent. Returns 0 on success. Deprecates zmsg_add, which did not nullify the caller's frame reference.

@param frame_p [#__ptr_give_ref] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 231
def append(frame_p)
  raise DestroyedError unless @ptr
  self_p = @ptr
  frame_p = frame_p.__ptr_give_ref
  result = ::CZMQ::FFI.zmsg_append(self_p, frame_p)
  result
end
content_size() click to toggle source

Return total size of all frames in message.

@return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 178
def content_size()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_content_size(self_p)
  result
end
destroy() click to toggle source

Destroy a message object and all frames it contains

@return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 128
def destroy()
  return unless @ptr
  self_p = __ptr_give_ref
  result = ::CZMQ::FFI.zmsg_destroy(self_p)
  result
end
dup() click to toggle source

Create copy of message, as new message object. Returns a fresh zmsg_t object. If message is null, or memory was exhausted, returns null.

@return [Zmsg]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 447
def dup()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_dup(self_p)
  result = Zmsg.__new result, true
  result
end
encode() click to toggle source

Serialize multipart message to a single message frame. Use this method to send structured messages across transports that do not support multipart data. Allocates and returns a new frame containing the serialized message. To decode a serialized message frame, use zmsg_decode ().

@return [Zframe]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 435
def encode()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_encode(self_p)
  result = Zframe.__new result, true
  result
end
eq(other) click to toggle source

Return true if the two messages have the same number of frames and each frame in the first message is identical to the corresponding frame in the other message. As with zframe_eq, return false if either message is NULL.

@param other [Zmsg, #__ptr] @return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 488
def eq(other)
  raise DestroyedError unless @ptr
  self_p = @ptr
  other = other.__ptr if other
  result = ::CZMQ::FFI.zmsg_eq(self_p, other)
  result
end
first() click to toggle source

Set cursor to first frame in message. Returns frame, or NULL, if the message is empty. Use this to navigate the frames as a list.

@return [Zframe]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 382
def first()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_first(self_p)
  result = Zframe.__new result, false
  result
end
last() click to toggle source

Return the last frame. If there are no frames, returns NULL.

@return [Zframe]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 405
def last()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_last(self_p)
  result = Zframe.__new result, false
  result
end
next() click to toggle source

Return the next frame. If there are no more frames, returns NULL. To move to the first frame call zmsg_first(). Advances the cursor.

@return [Zframe]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 394
def next()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_next(self_p)
  result = Zframe.__new result, false
  result
end
null?() click to toggle source

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 43
def null?
  !@ptr or @ptr.null?
end
pop() click to toggle source

Remove first frame from message, if any. Returns frame, or NULL.

@return [Zframe]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 242
def pop()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_pop(self_p)
  result = Zframe.__new result, true
  result
end
popmsg() click to toggle source

Remove first submessage from message, if any. Returns zmsg_t, or NULL if decoding was not successful.

@return [Zmsg]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 358
def popmsg()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_popmsg(self_p)
  result = Zmsg.__new result, true
  result
end
popstr() click to toggle source

Pop frame off front of message, return as fresh string. If there were no more frames in the message, returns NULL.

@return [::FFI::AutoPointer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 332
def popstr()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_popstr(self_p)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end
prepend(frame_p) click to toggle source

Push frame to the front of the message, i.e. before all other frames. Message takes ownership of frame, will destroy it when message is sent. Returns 0 on success, -1 on error. Deprecates zmsg_push, which did not nullify the caller's frame reference.

@param frame_p [#__ptr_give_ref] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 216
def prepend(frame_p)
  raise DestroyedError unless @ptr
  self_p = @ptr
  frame_p = frame_p.__ptr_give_ref
  result = ::CZMQ::FFI.zmsg_prepend(self_p, frame_p)
  result
end
print() click to toggle source

Send message to zsys log sink (may be stdout, or system facility as configured by zsys_set_logstream). Long messages are truncated.

@return [void]

print_n(size) click to toggle source

Send message to zsys log sink (may be stdout, or system facility as configured by zsys_set_logstream). Message length is specified; no truncation unless length is zero. Backwards compatible with zframe_print when length is zero.

@param size [Integer, to_int, to_i] @return [void]

pushmem(data, size) click to toggle source

Push block of memory to front of message, as a new frame. Returns 0 on success, -1 on error.

@param data [::FFI::Pointer, to_ptr] @param size [Integer, to_int, to_i] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 256
def pushmem(data, size)
  raise DestroyedError unless @ptr
  self_p = @ptr
  size = Integer(size)
  result = ::CZMQ::FFI.zmsg_pushmem(self_p, data, size)
  result
end
pushstr(string) click to toggle source

Push string as new frame to front of message. Returns 0 on success, -1 on error.

@param string [String, to_s, nil] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 283
def pushstr(string)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_pushstr(self_p, string)
  result
end
pushstrf(format, *args) click to toggle source

Push formatted string as new frame to front of message. Returns 0 on success, -1 on error.

@param format [String, to_s, nil] @param args [Array<Object>] see github.com/ffi/ffi/wiki/examples#using-varargs @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 308
def pushstrf(format, *args)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_pushstrf(self_p, format, *args)
  result
end
remove(frame) click to toggle source

Remove specified frame from list, if present. Does not destroy frame.

@param frame [Zframe, #__ptr] @return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 370
def remove(frame)
  raise DestroyedError unless @ptr
  self_p = @ptr
  frame = frame.__ptr if frame
  result = ::CZMQ::FFI.zmsg_remove(self_p, frame)
  result
end
routing_id() click to toggle source

Return message routing ID, if the message came from a ZMQ_SERVER socket. Else returns zero.

@return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 189
def routing_id()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_routing_id(self_p)
  result
end
save(file) click to toggle source

Save message to an open file, return 0 if OK, else -1. The message is saved as a series of frames, each with length and data. Note that the file is NOT guaranteed to be portable between operating systems, not versions of CZMQ. The file format is at present undocumented and liable to arbitrary change.

@param file [::FFI::Pointer, to_ptr] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 421
def save(file)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_save(self_p, file)
  result
end
set_routing_id(routing_id) click to toggle source

Set routing ID on message. This is used if/when the message is sent to a ZMQ_SERVER socket.

@param routing_id [Integer, to_int, to_i] @return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 201
def set_routing_id(routing_id)
  raise DestroyedError unless @ptr
  self_p = @ptr
  routing_id = Integer(routing_id)
  result = ::CZMQ::FFI.zmsg_set_routing_id(self_p, routing_id)
  result
end
signal() click to toggle source

Return signal value, 0 or greater, if message is a signal, -1 if not.

@return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 499
def signal()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_signal(self_p)
  result
end
size() click to toggle source

Return size of message, i.e. number of frames (0 or more).

@return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zmsg.rb, line 168
def size()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zmsg_size(self_p)
  result
end
to_ptr()

So external Libraries can just pass the Object to a FFI function which expects a :pointer

Alias for: __ptr