Class: VsClient::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/vs_client/configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfiguration

Set default values



19
20
21
22
23
24
25
26
27
# File 'lib/vs_client/configuration.rb', line 19

def initialize
  @logger = nil
  @use_ssl = true
  @enable_http_debug_mode = false
  @keep_alive_timeout = 60
  @open_timeout = 5
  @timeout = 5
  @api_version = ''
end

Instance Attribute Details

#api_versionObject

url => represent remote service (vendor search url). use_ssl => must be true if the url start with “https”. enable_http_debug_mode => enable tracing the request phases for debug use only. logger => represent Custom HSLogger we use in platform.

we can use different logger that has the same .log implementation.

keep_alive_timeout => represent the time in seconds to keep the current

tcp session opened for reusing the same tcp connection later.

open_timeout => time taken to open a connection with remote server. timeout => represent the time in seconds to read the data from remote server.



14
15
16
# File 'lib/vs_client/configuration.rb', line 14

def api_version
  @api_version
end

#enable_http_debug_modeObject

url => represent remote service (vendor search url). use_ssl => must be true if the url start with “https”. enable_http_debug_mode => enable tracing the request phases for debug use only. logger => represent Custom HSLogger we use in platform.

we can use different logger that has the same .log implementation.

keep_alive_timeout => represent the time in seconds to keep the current

tcp session opened for reusing the same tcp connection later.

open_timeout => time taken to open a connection with remote server. timeout => represent the time in seconds to read the data from remote server.



14
15
16
# File 'lib/vs_client/configuration.rb', line 14

def enable_http_debug_mode
  @enable_http_debug_mode
end

#keep_alive_timeoutObject

url => represent remote service (vendor search url). use_ssl => must be true if the url start with “https”. enable_http_debug_mode => enable tracing the request phases for debug use only. logger => represent Custom HSLogger we use in platform.

we can use different logger that has the same .log implementation.

keep_alive_timeout => represent the time in seconds to keep the current

tcp session opened for reusing the same tcp connection later.

open_timeout => time taken to open a connection with remote server. timeout => represent the time in seconds to read the data from remote server.



14
15
16
# File 'lib/vs_client/configuration.rb', line 14

def keep_alive_timeout
  @keep_alive_timeout
end

#loggerObject

url => represent remote service (vendor search url). use_ssl => must be true if the url start with “https”. enable_http_debug_mode => enable tracing the request phases for debug use only. logger => represent Custom HSLogger we use in platform.

we can use different logger that has the same .log implementation.

keep_alive_timeout => represent the time in seconds to keep the current

tcp session opened for reusing the same tcp connection later.

open_timeout => time taken to open a connection with remote server. timeout => represent the time in seconds to read the data from remote server.



14
15
16
# File 'lib/vs_client/configuration.rb', line 14

def logger
  @logger
end

#open_timeoutObject

url => represent remote service (vendor search url). use_ssl => must be true if the url start with “https”. enable_http_debug_mode => enable tracing the request phases for debug use only. logger => represent Custom HSLogger we use in platform.

we can use different logger that has the same .log implementation.

keep_alive_timeout => represent the time in seconds to keep the current

tcp session opened for reusing the same tcp connection later.

open_timeout => time taken to open a connection with remote server. timeout => represent the time in seconds to read the data from remote server.



14
15
16
# File 'lib/vs_client/configuration.rb', line 14

def open_timeout
  @open_timeout
end

#ssl_timeoutObject

url => represent remote service (vendor search url). use_ssl => must be true if the url start with “https”. enable_http_debug_mode => enable tracing the request phases for debug use only. logger => represent Custom HSLogger we use in platform.

we can use different logger that has the same .log implementation.

keep_alive_timeout => represent the time in seconds to keep the current

tcp session opened for reusing the same tcp connection later.

open_timeout => time taken to open a connection with remote server. timeout => represent the time in seconds to read the data from remote server.



14
15
16
# File 'lib/vs_client/configuration.rb', line 14

def ssl_timeout
  @ssl_timeout
end

#timeoutObject

url => represent remote service (vendor search url). use_ssl => must be true if the url start with “https”. enable_http_debug_mode => enable tracing the request phases for debug use only. logger => represent Custom HSLogger we use in platform.

we can use different logger that has the same .log implementation.

keep_alive_timeout => represent the time in seconds to keep the current

tcp session opened for reusing the same tcp connection later.

open_timeout => time taken to open a connection with remote server. timeout => represent the time in seconds to read the data from remote server.



14
15
16
# File 'lib/vs_client/configuration.rb', line 14

def timeout
  @timeout
end

#urlObject

url => represent remote service (vendor search url). use_ssl => must be true if the url start with “https”. enable_http_debug_mode => enable tracing the request phases for debug use only. logger => represent Custom HSLogger we use in platform.

we can use different logger that has the same .log implementation.

keep_alive_timeout => represent the time in seconds to keep the current

tcp session opened for reusing the same tcp connection later.

open_timeout => time taken to open a connection with remote server. timeout => represent the time in seconds to read the data from remote server.



14
15
16
# File 'lib/vs_client/configuration.rb', line 14

def url
  @url
end

#use_sslObject

url => represent remote service (vendor search url). use_ssl => must be true if the url start with “https”. enable_http_debug_mode => enable tracing the request phases for debug use only. logger => represent Custom HSLogger we use in platform.

we can use different logger that has the same .log implementation.

keep_alive_timeout => represent the time in seconds to keep the current

tcp session opened for reusing the same tcp connection later.

open_timeout => time taken to open a connection with remote server. timeout => represent the time in seconds to read the data from remote server.



14
15
16
# File 'lib/vs_client/configuration.rb', line 14

def use_ssl
  @use_ssl
end