Module: Ethon::Easy::Options Private

Included in:
Ethon::Easy
Defined in:
lib/ethon/easy/options.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

This module contains the logic and knowledge about the available options on easy.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#url ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



10
11
12
 
# File 'lib/ethon/easy/options.rb', line 10

def url
  @url
end

Instance Method Details

#cainfo=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets cainfo option.

Examples:

Set cainfo option.

easy.cainfo = $value

Parameters:

  • value (String) —

    The value to set.



20
21
22
 
# File 'lib/ethon/easy/options.rb', line 20

def cainfo=(value)
  Curl.set_option(:cainfo, value_for(value, :string), handle)
end

#capath=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets capath option.

Examples:

Set capath option.

easy.capath = $value

Parameters:

  • value (String) —

    The value to set.



32
33
34
 
# File 'lib/ethon/easy/options.rb', line 32

def capath=(value)
  Curl.set_option(:capath, value_for(value, :string), handle)
end

#connecttimeout=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets connecttimeout option.

Examples:

Set connecttimeout option.

easy.connecttimeout = 1

Parameters:

  • value (Integer) —

    The value to set.



44
45
46
 
# File 'lib/ethon/easy/options.rb', line 44

def connecttimeout=(value)
  Curl.set_option(:connecttimeout, value_for(value, :int), handle)
end

#connecttimeout_ms=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets connecttimeout_ms option.

Examples:

Set connecttimeout_ms option.

easy.connecttimeout_ms = 1

Parameters:

  • value (Integer) —

    The value to set.



56
57
58
 
# File 'lib/ethon/easy/options.rb', line 56

def connecttimeout_ms=(value)
  Curl.set_option(:connecttimeout_ms, value_for(value, :int), handle)
end

#copypostfields=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets copypostfields option.

Examples:

Set copypostfields option.

easy.copypostfields = $value

Parameters:

  • value (String) —

    The value to set.



68
69
70
 
# File 'lib/ethon/easy/options.rb', line 68

def copypostfields=(value)
  Curl.set_option(:copypostfields, value_for(value, :string), handle)
end

#customrequest=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets customrequest option.

Examples:

Set customrequest option.

easy.customrequest = $value

Parameters:

  • value (String) —

    The value to set.



80
81
82
 
# File 'lib/ethon/easy/options.rb', line 80

def customrequest=(value)
  Curl.set_option(:customrequest, value_for(value, :string), handle)
end

#dns_cache_timeout=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets dns_cache_timeout option.

Examples:

Set dns_cache_timeout option.

easy.dns_cache_timeout = 1

Parameters:

  • value (Integer) —

    The value to set.



92
93
94
 
# File 'lib/ethon/easy/options.rb', line 92

def dns_cache_timeout=(value)
  Curl.set_option(:dns_cache_timeout, value_for(value, :int), handle)
end

#followlocation=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets followlocation option.

Examples:

Set followlocation option.

easy.followlocation = true

Parameters:

  • value (Boolean) —

    The value to set.



104
105
106
 
# File 'lib/ethon/easy/options.rb', line 104

def followlocation=(value)
  Curl.set_option(:followlocation, value_for(value, :bool), handle)
end

#forbid_reuse=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets forbid_reuse option.

Examples:

Set forbid_reuse option.

easy.forbid_reuse = true

Parameters:

  • value (Boolean) —

    The value to set.



116
117
118
 
# File 'lib/ethon/easy/options.rb', line 116

def forbid_reuse=(value)
  Curl.set_option(:forbid_reuse, value_for(value, :bool), handle)
end

#httpauth=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets httpauth option.

Examples:

Set httpauth option.

easy.httpauth = $value

Parameters:

  • value ($type_doc) —

    The value to set.



128
129
130
 
# File 'lib/ethon/easy/options.rb', line 128

def httpauth=(value)
  Curl.set_option(:httpauth, value_for(value, :enum, :httpauth), handle)
end

#httpget=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets httpget option.

Examples:

Set httpget option.

easy.httpget = true

Parameters:

  • value (Boolean) —

    The value to set.



140
141
142
 
# File 'lib/ethon/easy/options.rb', line 140

def httpget=(value)
  Curl.set_option(:httpget, value_for(value, :bool), handle)
end

#httppost=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets httppost option.

Examples:

Set httppost option.

easy.httppost = $value

Parameters:

  • value (String) —

    The value to set.



152
153
154
 
# File 'lib/ethon/easy/options.rb', line 152

def httppost=(value)
  Curl.set_option(:httppost, value_for(value, :string), handle)
end

#infilesize=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets infilesize option.

Examples:

Set infilesize option.

easy.infilesize = 1

Parameters:

  • value (Integer) —

    The value to set.



164
165
166
 
# File 'lib/ethon/easy/options.rb', line 164

def infilesize=(value)
  Curl.set_option(:infilesize, value_for(value, :int), handle)
end

#interface=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets interface option.

Examples:

Set interface option.

easy.interface = $value

Parameters:

  • value (String) —

    The value to set.



176
177
178
 
# File 'lib/ethon/easy/options.rb', line 176

def interface=(value)
  Curl.set_option(:interface, value_for(value, :string), handle)
end

#keypasswd=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets keypasswd option.

Examples:

Set keypasswd option.

easy.keypasswd = $value

Parameters:

  • value (String) —

    The value to set.



188
189
190
 
# File 'lib/ethon/easy/options.rb', line 188

def keypasswd=(value)
  Curl.set_option(:keypasswd, value_for(value, :string), handle)
end

#maxredirs=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets maxredirs option.

Examples:

Set maxredirs option.

easy.maxredirs = 1

Parameters:

  • value (Integer) —

    The value to set.



200
201
202
 
# File 'lib/ethon/easy/options.rb', line 200

def maxredirs=(value)
  Curl.set_option(:maxredirs, value_for(value, :int), handle)
end

#nobody=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets nobody option.

Examples:

Set nobody option.

easy.nobody = true

Parameters:

  • value (Boolean) —

    The value to set.



212
213
214
 
# File 'lib/ethon/easy/options.rb', line 212

def nobody=(value)
  Curl.set_option(:nobody, value_for(value, :bool), handle)
end

#nosignal=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets nosignal option.

Examples:

Set nosignal option.

easy.nosignal = true

Parameters:

  • value (Boolean) —

    The value to set.



224
225
226
 
# File 'lib/ethon/easy/options.rb', line 224

def nosignal=(value)
  Curl.set_option(:nosignal, value_for(value, :bool), handle)
end

#postfieldsize=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets postfieldsize option.

Examples:

Set postfieldsize option.

easy.postfieldsize = 1

Parameters:

  • value (Integer) —

    The value to set.



236
237
238
 
# File 'lib/ethon/easy/options.rb', line 236

def postfieldsize=(value)
  Curl.set_option(:postfieldsize, value_for(value, :int), handle)
end

#proxy=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets proxy option.

Examples:

Set proxy option.

easy.proxy = $value

Parameters:

  • value (String) —

    The value to set.



248
249
250
 
# File 'lib/ethon/easy/options.rb', line 248

def proxy=(value)
  Curl.set_option(:proxy, value_for(value, :string), handle)
end

#proxyauth=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets proxyauth option.

Examples:

Set proxyauth option.

easy.proxyauth = $value

Parameters:

  • value (String) —

    The value to set.



260
261
262
 
# File 'lib/ethon/easy/options.rb', line 260

def proxyauth=(value)
  Curl.set_option(:proxyauth, value_for(value, :string), handle)
end

#proxyport=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets proxyport option.

Examples:

Set proxyport option.

easy.proxyport = 1

Parameters:

  • value (Integer) —

    The value to set.



272
273
274
 
# File 'lib/ethon/easy/options.rb', line 272

def proxyport=(value)
  Curl.set_option(:proxyport, value_for(value, :int), handle)
end

#proxytype=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets proxytype option.

Examples:

Set proxytype option.

easy.proxytype = $value

Parameters:

  • value (String) —

    The value to set.



284
285
286
 
# File 'lib/ethon/easy/options.rb', line 284

def proxytype=(value)
  Curl.set_option(:proxytype, value_for(value, :string), handle)
end

#proxyuserpwd=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets proxyuserpwd option.

Examples:

Set proxyuserpwd option.

easy.proxyuserpwd = $value

Parameters:

  • value (String) —

    The value to set.



296
297
298
 
# File 'lib/ethon/easy/options.rb', line 296

def proxyuserpwd=(value)
  Curl.set_option(:proxyuserpwd, value_for(value, :string), handle)
end

#readdata=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets readdata option.

Examples:

Set readdata option.

easy.readdata = $value

Parameters:

  • value (String) —

    The value to set.



308
309
310
 
# File 'lib/ethon/easy/options.rb', line 308

def readdata=(value)
  Curl.set_option(:readdata, value_for(value, :string), handle)
end

#readfunction=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets readfunction option.

Examples:

Set readfunction option.

easy.readfunction = $value

Parameters:

  • value (String) —

    The value to set.



320
321
322
 
# File 'lib/ethon/easy/options.rb', line 320

def readfunction=(value)
  Curl.set_option(:readfunction, value_for(value, :string), handle)
end

#ssl_verifyhost=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets ssl_verifyhost option.

Examples:

Set ssl_verifyhost option.

easy.ssl_verifyhost = 1

Parameters:

  • value (Integer) —

    The value to set.



332
333
334
 
# File 'lib/ethon/easy/options.rb', line 332

def ssl_verifyhost=(value)
  Curl.set_option(:ssl_verifyhost, value_for(value, :int), handle)
end

#ssl_verifypeer=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets ssl_verifypeer option.

Examples:

Set ssl_verifypeer option.

easy.ssl_verifypeer = true

Parameters:

  • value (Boolean) —

    The value to set.



344
345
346
 
# File 'lib/ethon/easy/options.rb', line 344

def ssl_verifypeer=(value)
  Curl.set_option(:ssl_verifypeer, value_for(value, :bool), handle)
end

#sslcert=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets sslcert option.

Examples:

Set sslcert option.

easy.sslcert = $value

Parameters:

  • value (String) —

    The value to set.



356
357
358
 
# File 'lib/ethon/easy/options.rb', line 356

def sslcert=(value)
  Curl.set_option(:sslcert, value_for(value, :string), handle)
end

#sslcerttype=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets sslcerttype option.

Examples:

Set sslcerttype option.

easy.sslcerttype = $value

Parameters:

  • value (String) —

    The value to set.



368
369
370
 
# File 'lib/ethon/easy/options.rb', line 368

def sslcerttype=(value)
  Curl.set_option(:sslcerttype, value_for(value, :string), handle)
end

#sslkey=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets sslkey option.

Examples:

Set sslkey option.

easy.sslkey = $value

Parameters:

  • value (String) —

    The value to set.



380
381
382
 
# File 'lib/ethon/easy/options.rb', line 380

def sslkey=(value)
  Curl.set_option(:sslkey, value_for(value, :string), handle)
end

#sslkeytype=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets sslkeytype option.

Examples:

Set sslkeytype option.

easy.sslkeytype = $value

Parameters:

  • value (String) —

    The value to set.



392
393
394
 
# File 'lib/ethon/easy/options.rb', line 392

def sslkeytype=(value)
  Curl.set_option(:sslkeytype, value_for(value, :string), handle)
end

#sslversion=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets sslversion option.

Examples:

Set sslversion option.

easy.sslversion = $value

Parameters:

  • value ($type_doc) —

    The value to set.



404
405
406
 
# File 'lib/ethon/easy/options.rb', line 404

def sslversion=(value)
  Curl.set_option(:sslversion, value_for(value, :enum, :sslversion), handle)
end

#timeout=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets timeout option.

Examples:

Set timeout option.

easy.timeout = 1

Parameters:

  • value (Integer) —

    The value to set.



416
417
418
 
# File 'lib/ethon/easy/options.rb', line 416

def timeout=(value)
  Curl.set_option(:timeout, value_for(value, :int), handle)
end

#timeout_ms=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets timeout_ms option.

Examples:

Set timeout_ms option.

easy.timeout_ms = 1

Parameters:

  • value (Integer) —

    The value to set.



428
429
430
 
# File 'lib/ethon/easy/options.rb', line 428

def timeout_ms=(value)
  Curl.set_option(:timeout_ms, value_for(value, :int), handle)
end

#upload=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets upload option.

Examples:

Set upload option.

easy.upload = true

Parameters:

  • value (Boolean) —

    The value to set.



440
441
442
 
# File 'lib/ethon/easy/options.rb', line 440

def upload=(value)
  Curl.set_option(:upload, value_for(value, :bool), handle)
end

#useragent=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets useragent option.

Examples:

Set useragent option.

easy.useragent = $value

Parameters:

  • value (String) —

    The value to set.



465
466
467
 
# File 'lib/ethon/easy/options.rb', line 465

def useragent=(value)
  Curl.set_option(:useragent, value_for(value, :string), handle)
end

#userpwd=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets userpwd option.

Examples:

Set userpwd option.

easy.userpwd = $value

Parameters:

  • value (String) —

    The value to set.



477
478
479
 
# File 'lib/ethon/easy/options.rb', line 477

def userpwd=(value)
  Curl.set_option(:userpwd, value_for(value, :string), handle)
end

#verbose=(value) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Sets verbose option.

Examples:

Set verbose option.

easy.verbose = true

Parameters:

  • value (Boolean) —

    The value to set.



489
490
491
 
# File 'lib/ethon/easy/options.rb', line 489

def verbose=(value)
  Curl.set_option(:verbose, value_for(value, :bool), handle)
end