Class: CZMQ::FFI::ZhttpServerOptions

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

Overview

Note:

This class is 100% generated using zproject.

zhttp server.

Defined Under Namespace

Classes: DestroyedError

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ptr, finalize = true) ⇒ ZhttpServerOptions

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/zhttp_server_options.rb', line 24

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

Class Method Details

.__new ⇒ Object 



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

alias :__new :new

.create_finalizer_for(ptr) ⇒ Proc

Parameters:

  • ptr (::FFI::Pointer)

Returns:

  • (Proc) 


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

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

  Proc.new do
    ptr_ptr.write_pointer ptr
    ::CZMQ::FFI.zhttp_server_options_destroy ptr_ptr
  end
end

.from_config(config) ⇒ CZMQ::ZhttpServerOptions

Create options from config tree.

Parameters:

Returns:

  • (CZMQ::ZhttpServerOptions) 


87
88
89
90
91
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_server_options.rb', line 87

def self.from_config(config)
  config = config.__ptr if config
  ptr = ::CZMQ::FFI.zhttp_server_options_from_config(config)
  __new ptr
end

.new ⇒ CZMQ::ZhttpServerOptions

Create a new zhttp_server_options.

Returns:

  • (CZMQ::ZhttpServerOptions) 


79
80
81
82
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_server_options.rb', line 79

def self.new()
  ptr = ::CZMQ::FFI.zhttp_server_options_new()
  __new ptr
end

.test(verbose) ⇒ void

This method returns an undefined value.

Self test of this class.

Parameters:

  • verbose (Boolean) 


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

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

Instance Method Details

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

Return internal pointer

Returns:

  • (::FFI::Pointer)

Raises:



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

def __ptr
  raise DestroyedError unless @ptr
  @ptr
end

#__ptr_give_ref ⇒ ::FFI::MemoryPointer

Note:

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

Nullify internal pointer and return pointer pointer.

Returns:

  • (::FFI::MemoryPointer) —

    the pointer pointing to a pointer pointing to the native object

Raises:



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

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

#__undef_finalizer ⇒ void

Note:

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

This method returns an undefined value.

Undefines the finalizer for this object.



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

def __undef_finalizer
  ObjectSpace.undefine_finalizer self
  @finalizer = nil
end

#backend_address ⇒ String

Get the address sockets should connect to in order to receive requests.

Returns:

  • (String)

Raises:



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

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

#destroy ⇒ void

This method returns an undefined value.

Destroy the zhttp_server_options.



96
97
98
99
100
101
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_server_options.rb', line 96

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

#null? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#port ⇒ Integer

Get the server listening port.

Returns:

  • (Integer)

Raises:



106
107
108
109
110
111
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_server_options.rb', line 106

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

#set_backend_address(address) ⇒ void

This method returns an undefined value.

Set the address sockets should connect to in order to receive requests.

Parameters:

  • address (String, #to_s, nil)

Raises:



139
140
141
142
143
144
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_server_options.rb', line 139

def set_backend_address(address)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zhttp_server_options_set_backend_address(self_p, address)
  result
end

#set_port(port) ⇒ void

This method returns an undefined value.

Set the server listening port

Parameters:

  • port (Integer, #to_int, #to_i)

Raises:



117
118
119
120
121
122
123
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_server_options.rb', line 117

def set_port(port)
  raise DestroyedError unless @ptr
  self_p = @ptr
  port = Integer(port)
  result = ::CZMQ::FFI.zhttp_server_options_set_port(self_p, port)
  result
end