Class: CZMQ::FFI::ZhttpRequest

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

Overview

Note:

This class is 100% generated using zproject.

Http request that can be received from zhttp_server or sent to zhttp_client. Class can be reused between send & recv calls. Headers and Content is being destroyed after every send call.

Defined Under Namespace

Classes: DestroyedError

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ptr, finalize = true) ⇒ ZhttpRequest

Attaches the pointer ptr to this instance and defines a finalizer for it if necessary.

Parameters:

  • ptr (::FFI::Pointer)
  • finalize (Boolean) (defaults to: true) 


26
27
28
29
30
31
32
33
34
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 26

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 



20
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 20

alias :__new :new

.create_finalizer_for(ptr) ⇒ Proc

Parameters:

  • ptr (::FFI::Pointer)

Returns:

  • (Proc) 


37
38
39
40
41
42
43
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 37

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

.new ⇒ CZMQ::ZhttpRequest

Create a new http request.

Returns:

  • (CZMQ::ZhttpRequest) 


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

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

.test(verbose) ⇒ void

This method returns an undefined value.

Self test of this class.

Parameters:

  • verbose (Boolean) 


300
301
302
303
304
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 300

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

Instance Method Details

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

Return internal pointer

Returns:

  • (::FFI::Pointer)

Raises:



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

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:



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

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.



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

def __undef_finalizer
  ObjectSpace.undefine_finalizer self
  @finalizer = nil
end

#content ⇒ String

Get the content of the request.

Returns:

  • (String)

Raises:



218
219
220
221
222
223
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 218

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

#content_length ⇒ Integer

Get the content length of the request

Returns:

  • (Integer)

Raises:



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

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

#content_type ⇒ String

Get the request content type

Returns:

  • (String)

Raises:



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

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

#destroy ⇒ void

This method returns an undefined value.

Destroy an http request.



88
89
90
91
92
93
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 88

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

#get_content ⇒ ::FFI::AutoPointer

Get the content of the request.

Returns:

  • (::FFI::AutoPointer)

Raises:



228
229
230
231
232
233
234
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 228

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

#headers ⇒ Zhash

Get the headers of the request

Returns:

Raises:



207
208
209
210
211
212
213
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 207

def headers()
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zhttp_request_headers(self_p)
  result = Zhash.__new result, false
  result
end

#match(method, path, *args) ⇒ Boolean

Match the path of the request. Support wildcards with ‘%s’ symbol inside the match string. Matching wildcards until the next ‘/’, ‘?’ or ‘0’. On successful match the variadic arguments will be filled with the matching strings. On successful match the method is modifying the url field and break it into substrings. If you need to use the url, do it before matching or take a copy.

User must not free the variadic arguments as they are part of the url.

To use the percent symbol, just double it, e.g “%%something”.

Example: if (zhttp_request_match (request, “POST”, “/send/%s/%s”, &name, &id))

Parameters:

Returns:

  • (Boolean)

Raises:



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

def match(method, path, *args)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zhttp_request_match(self_p, method, path, *args)
  result
end

#method ⇒ String

Get the request method

Returns:

  • (String)

Raises:



132
133
134
135
136
137
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 132

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

#null? ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 45

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

#recv(sock) ⇒ ::FFI::Pointer

Receive a new request from zhttp_server. Return the underlying connection if successful, to be used when calling zhttp_response_send.

Parameters:

Returns:

  • (::FFI::Pointer)

Raises:



100
101
102
103
104
105
106
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 100

def recv(sock)
  raise DestroyedError unless @ptr
  self_p = @ptr
  sock = sock.__ptr if sock
  result = ::CZMQ::FFI.zhttp_request_recv(self_p, sock)
  result
end

#reset_content ⇒ void

This method returns an undefined value.

Set the content to NULL

Raises:



264
265
266
267
268
269
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 264

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

#send(client, timeout, arg, arg2) ⇒ Integer

Send a request to zhttp_client. Url and the request path will be concatenated. This behavior is useful for url rewrite and reverse proxy.

Send also allow two user provided arguments which will be returned with the response. The reason for two, is to be able to pass around the server connection when forwarding requests or both a callback function and an arg.

Parameters:

Returns:

  • (Integer)

Raises:



120
121
122
123
124
125
126
127
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 120

def send(client, timeout, arg, arg2)
  raise DestroyedError unless @ptr
  self_p = @ptr
  client = client.__ptr if client
  timeout = Integer(timeout)
  result = ::CZMQ::FFI.zhttp_request_send(self_p, client, timeout, arg, arg2)
  result
end

#set_content(content) ⇒ void

This method returns an undefined value.

Set the content of the request. Content must by dynamically allocated string. Takes ownership of the content.

Parameters:

  • content (::FFI::Pointer, #to_ptr)

Raises:



242
243
244
245
246
247
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 242

def set_content(content)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zhttp_request_set_content(self_p, content)
  result
end

#set_content_const(content) ⇒ void

This method returns an undefined value.

Set the content of the request.. The content is assumed to be constant-memory and will therefore not be copied or deallocated in any way.

Parameters:

  • content (String, #to_s, nil)

Raises:



254
255
256
257
258
259
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 254

def set_content_const(content)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zhttp_request_set_content_const(self_p, content)
  result
end

#set_content_type(content_type) ⇒ void

This method returns an undefined value.

Set the request content type

Parameters:

  • content_type (String, #to_s, nil)

Raises:



187
188
189
190
191
192
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 187

def set_content_type(content_type)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zhttp_request_set_content_type(self_p, content_type)
  result
end

#set_method(method) ⇒ void

This method returns an undefined value.

Set the request method

Parameters:

  • method (String, #to_s, nil)

Raises:



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

def set_method(method)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zhttp_request_set_method(self_p, method)
  result
end

#set_url(url) ⇒ void

This method returns an undefined value.

Set the request url When sending a request to http client this should be full url.

Parameters:

  • url (String, #to_s, nil)

Raises:



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

def set_url(url)
  raise DestroyedError unless @ptr
  self_p = @ptr
  result = ::CZMQ::FFI.zhttp_request_set_url(self_p, url)
  result
end

#url ⇒ String

Get the request url. When receiving a request from http server this is only the path part of the url.

Returns:

  • (String)

Raises:



154
155
156
157
158
159
 
# File 'lib/czmq-ffi-gen/czmq/ffi/zhttp_request.rb', line 154

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