class CZMQ::FFI::Zstr

sending and receiving strings @note This class is 100% generated using zproject.

Public Class Methods

create_finalizer_for(ptr) click to toggle source

@return [Proc]

# File lib/czmq-ffi-gen/czmq/ffi/zstr.rb, line 34
def self.create_finalizer_for(ptr)
  Proc.new do
    "WARNING: "\
    "Objects of type #{self} cannot be destroyed implicitly. "\
    "Please call the correct destroy method with the relevant arguments."
  end
end
free(string_p) click to toggle source

Free a provided string, and nullify the parent pointer. Safe to call on a null pointer.

@param string_p [::FFI::Pointer, to_ptr] @return [void]

# File lib/czmq-ffi-gen/czmq/ffi/zstr.rb, line 221
def self.free(string_p)
  result = ::CZMQ::FFI.zstr_free(string_p)
  result
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/zstr.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
recv(source) click to toggle source

Receive C string from socket. Caller must free returned string using zstr_free(). Returns NULL if the context is being terminated or the process was interrupted.

@param source [::FFI::Pointer, to_ptr] @return [::FFI::AutoPointer]

# File lib/czmq-ffi-gen/czmq/ffi/zstr.rb, line 81
def self.recv(source)
  result = ::CZMQ::FFI.zstr_recv(source)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end
recv_compress(source) click to toggle source

De-compress and receive C string from socket, received as a message with two frames: size of the uncompressed string, and the string itself. Caller must free returned string using zstr_free(). Returns NULL if the context is being terminated or the process was interrupted.

@param source [::FFI::Pointer, to_ptr] @return [::FFI::AutoPointer]

# File lib/czmq-ffi-gen/czmq/ffi/zstr.rb, line 111
def self.recv_compress(source)
  result = ::CZMQ::FFI.zstr_recv_compress(source)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  result
end
recvx(source, string_p, *args) click to toggle source

Receive a series of strings (until NULL) from multipart data. Each string is allocated and filled with string data; if there are not enough frames, unallocated strings are set to NULL. Returns -1 if the message could not be read, else returns the number of strings filled, zero or more. Free each returned string using zstr_free(). If not enough strings are provided, remaining multipart frames in the message are dropped.

@param source [::FFI::Pointer, to_ptr] @param string_p [::FFI::Pointer, to_ptr] @param args [Array<Object>] see github.com/ffi/ffi/wiki/examples#using-varargs @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zstr.rb, line 99
def self.recvx(source, string_p, *args)
  result = ::CZMQ::FFI.zstr_recvx(source, string_p, *args)
  result
end
send(dest, string) click to toggle source

Send a C string to a socket, as a frame. The string is sent without trailing null byte; to read this you can use zstr_recv, or a similar method that adds a null terminator on the received string. String may be NULL, which is sent as “”.

@param dest [::FFI::Pointer, to_ptr] @param string [String, to_s, nil] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zstr.rb, line 125
def self.send(dest, string)
  result = ::CZMQ::FFI.zstr_send(dest, string)
  result
end
send_compress(dest, string) click to toggle source

Compress and send a C string to a socket, as a message with two frames: size of the uncompressed string, and the string itself. The string is sent without trailing null byte; to read this you can use zstr_recv_compress, or a similar method that de-compresses and adds a null terminator on the received string.

@param dest [::FFI::Pointer, to_ptr] @param string [String, to_s, nil] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zstr.rb, line 188
def self.send_compress(dest, string)
  result = ::CZMQ::FFI.zstr_send_compress(dest, string)
  result
end
sendf(dest, format, *args) click to toggle source

Send a formatted string to a socket. Note that you should NOT use user-supplied strings in the format (they may contain '%' which will create security holes).

@param dest [::FFI::Pointer, to_ptr] @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/zstr.rb, line 149
def self.sendf(dest, format, *args)
  result = ::CZMQ::FFI.zstr_sendf(dest, format, *args)
  result
end
sendfm(dest, format, *args) click to toggle source

Send a formatted string to a socket, as for zstr_sendf(), with a MORE flag, so that you can send further strings in the same multi-part message.

@param dest [::FFI::Pointer, to_ptr] @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/zstr.rb, line 162
def self.sendfm(dest, format, *args)
  result = ::CZMQ::FFI.zstr_sendfm(dest, format, *args)
  result
end
sendm(dest, string) click to toggle source

Send a C string to a socket, as zstr_send(), with a MORE flag, so that you can send further strings in the same multi-part message.

@param dest [::FFI::Pointer, to_ptr] @param string [String, to_s, nil] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zstr.rb, line 136
def self.sendm(dest, string)
  result = ::CZMQ::FFI.zstr_sendm(dest, string)
  result
end
sendm_compress(dest, string) click to toggle source

Compress and send a C string to a socket, as zstr_send_compress(), with a MORE flag, so that you can send further strings in the same multi-part message.

@param dest [::FFI::Pointer, to_ptr] @param string [String, to_s, nil] @return [Integer]

# File lib/czmq-ffi-gen/czmq/ffi/zstr.rb, line 200
def self.sendm_compress(dest, string)
  result = ::CZMQ::FFI.zstr_sendm_compress(dest, string)
  result
end
sendx(dest, string, *args) click to toggle source

Send a series of strings (until NULL) as multipart data Returns 0 if the strings could be sent OK, or -1 on error.

@param dest [::FFI::Pointer, to_ptr] @param string [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/zstr.rb, line 174
def self.sendx(dest, string, *args)
  result = ::CZMQ::FFI.zstr_sendx(dest, string, *args)
  result
end
str(source) click to toggle source

Accepts a void pointer and returns a fresh character string. If source is null, returns an empty string.

@param source [::FFI::Pointer, to_ptr] @return [::FFI::AutoPointer]

# File lib/czmq-ffi-gen/czmq/ffi/zstr.rb, line 210
def self.str(source)
  result = ::CZMQ::FFI.zstr_str(source)
  result = ::FFI::AutoPointer.new(result, LibC.method(:free))
  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/zstr.rb, line 230
def self.test(verbose)
  verbose = !(0==verbose||!verbose) # boolean
  result = ::CZMQ::FFI.zstr_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/zstr.rb, line 47
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/zstr.rb, line 58
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/zstr.rb, line 70
def __undef_finalizer
  ObjectSpace.undefine_finalizer self
  @finalizer = nil
end
null?() click to toggle source

@return [Boolean]

# File lib/czmq-ffi-gen/czmq/ffi/zstr.rb, line 42
def null?
  !@ptr or @ptr.null?
end
to_ptr()

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

Alias for: __ptr